Class TotalStationCapacityParametricAnalysis

java.lang.Object
common.definitions.parametric.ParametricAnalysisDefinition
common.definitions.parametric.TotalStationCapacityParametricAnalysis
All Implemented Interfaces:
ParametricAnalysis
public class TotalStationCapacityParametricAnalysis extends ParametricAnalysisDefinition

Title: TotalStationCapacityParametricAnalysis

Description: this class is used to describe a parametric analysis where the varied parameter is the total capacity inside a station. It adds the stationKey field, used to keep the key of the station whose total capacity will be varied

.
Author:
Xinyu Gao Date: 20-June-2023 Time: XXXX

  • Constructor Details

  • Method Details

    • setDefaultInitialValue

      public void setDefaultInitialValue()
      Sets the default initial Value

    • setDefaultFinalValue

      public void setDefaultFinalValue()
      Sets default final value

    • getReferenceClass

      public Object getReferenceClass()
      Gets the class key of the job class whose number of servers will be increased. If the simulation is not single class, the null value will be returned
      Specified by:
      getReferenceClass in class ParametricAnalysisDefinition
      Returns:
      the key of the class whose number of servers will be increased if the parametric analysis is single class, null otherwise.

    • getReferenceClassName

      public String getReferenceClassName()
      Get the reference class name
      Specified by:
      getReferenceClassName in class ParametricAnalysisDefinition
      Returns:
      the name of the class

    • getProperties

      public Map<String,String> getProperties()
      Gets a TreeMap containing for each property its value. The supported properties are defined as constants inside this class.
      Specified by:
      getProperties in class ParametricAnalysisDefinition
      Returns:
      a TreeMap containing the value for each property

    • setProperty

      public void setProperty(String propertyName, String value)
      Sets the value for the specified property. The supported properties are:
      - TO_PROPERTY
      - FROM_PROPERTY
      - STEPS_PROPERTY
      - REFERENCE_STATION_PROPERTY
      Specified by:
      setProperty in class ParametricAnalysisDefinition
      Parameters:
      propertyName - the name of the property to be set
      value - the value to be set

    • getReferenceStation

      public Object getReferenceStation()
      Gets the station key whose total capacity will be varied
      Returns:
      the key of the station whose total capacity will be varied

    • getReferenceStationName

      public String getReferenceStationName()
      Gets name of the whose total capacity will be varied
      Returns:
      the key of the station whose total capacity will be varied

    • setReferenceStation

      public void setReferenceStation(Object stationKey)
      Sets the station whose total capacity will be varied
      Parameters:
      stationKey - the station whose total capacity will be varied

    • getType

      public String getType()
      Gets the type of parametric analysis
      Specified by:
      getType in class ParametricAnalysisDefinition
      Returns:
      the type of parametric analysis

    • changeModel

      public void changeModel(int step)
      Changes the model preparing it for the next step
      Specified by:
      changeModel in class ParametricAnalysisDefinition

    • searchForAvailableSteps

      public int searchForAvailableSteps()
      Gets the maximum number of steps compatible with the model definition and the type of parametric analysis.
      Specified by:
      searchForAvailableSteps in class ParametricAnalysisDefinition
      Returns:
      the maximum number of steps

    • createValuesSet

      public void createValuesSet()
      Finds the set of possible values of the parameter on which the simulation may be iterated on.
      Specified by:
      createValuesSet in class ParametricAnalysisDefinition

    • restoreOriginalValues

      public void restoreOriginalValues()
      Restore the original values of total capacity
      Specified by:
      restoreOriginalValues in class ParametricAnalysisDefinition

    • checkCorrectness

      public int checkCorrectness(boolean autocorrect)
      Checks if the PA model is still coherent with simulation model definition. If the autocorrect variable is set to true, if the PA model is no more valid but it can be corrected it will be changed.
      Specified by:
      checkCorrectness in class ParametricAnalysisDefinition
      Parameters:
      autocorrect - if true the PA model will be autocorrected
      Returns:
      0 - If the PA model is still valid
      1 - If the PA model is no more valid, but it will be corrected
      2 - If the PA model can be no more used

    • getParameterValues

      public Vector<Number> getParameterValues()
      Returns the values assumed by the varying parameter
      Specified by:
      getParameterValues in class ParametricAnalysisDefinition
      Returns:
      a Vector containing the values assumed by the varying parameter