Enum Class FWSimVariable.VARIABLE_CATEGORY
java.lang.Object
java.lang.Enum<FWSimVariable.VARIABLE_CATEGORY>
net.simplace.sim.util.FWSimVariable.VARIABLE_CATEGORY
- All Implemented Interfaces:
Serializable, Comparable<FWSimVariable.VARIABLE_CATEGORY>, Constable
- Enclosing class:
FWSimVariable<T>
Finer categorisation of variables than
FWSimVariable.CONTENT_TYPE, used to group variables in lists (e.g. in the GUI).- Author:
- Andreas Enders
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAction rule of a management componentVariable of a calibration (generator)Frequency rule of a SimComponentConstant input of a SimComponent (name prefix: c)Dynamic input of a SimComponent (name prefix: i)Key variable of a resourceVariable of a management componentOutput of a SimComponent that is neither a rate nor a state (no prefix)Variable of an outputFrequency rule of an outputReplacement parameterVariable only used internally in a SimComponent (name prefix: p).Variable specific to the project control processOutput of a SimComponent that is a rate changing a state variable (name prefix: r)Variable from a resourceFrequency rule of a resourceOutput of a SimComponent whose value is kept in the component for the next time step (name prefix: s)System variable, e.g.Variable of a project or solution (name prefix: v) -
Method Summary
Modifier and TypeMethodDescriptionReturns the enum constant of this class with the specified name.static FWSimVariable.VARIABLE_CATEGORY[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
var
Variable of a project or solution (name prefix: v) -
privat
Variable only used internally in a SimComponent (name prefix: p). Spelled "privat" because "private" is a reserved word. -
res
Variable from a resource -
key
Key variable of a resource -
res_frequency
Frequency rule of a resource -
output
Variable of an output -
output_frequency
Frequency rule of an output -
constant
Constant input of a SimComponent (name prefix: c) -
state
Output of a SimComponent whose value is kept in the component for the next time step (name prefix: s) -
rate
Output of a SimComponent that is a rate changing a state variable (name prefix: r) -
input
Dynamic input of a SimComponent (name prefix: i) -
out
Output of a SimComponent that is neither a rate nor a state (no prefix) -
sys
System variable, e.g. CURRENT.DATE or the project id -
action_rule
Action rule of a management component -
mgm
Variable of a management component -
cal
Variable of a calibration (generator) -
proj
Variable specific to the project control process -
param
Replacement parameter -
component_frequency
Frequency rule of a SimComponent
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-