net.simplace.simulation.util.FWSimVariable

public static FWSimVariable createSimVariable(Element aVarElement,
FWSimFieldContainer aFWSimFieldContainer);

factory method to create a FWSimVariable (Typed)

• aVarElement
• aFWSimFieldContainer

returns the new created Variable

public static FWSimVariable createSimVariable(String aName, String aDesc,
FWSimVariable.DATA_TYPE aDataType, FWSimVariable.CONTENT_TYPE
aContentType, String aUnit, Number aMin, Number aMax, Object aDefault,
FWSimFieldContainer aSourceSimComponent);

factory method to create a component sim variable for net.simplace.simulation.util.FWSimVariable.CONTENT_TYPE out use method above

• aName
• aDesc
• aDataType
• aContentType
• aUnit
• aMin
• aMax
• aDefault
• aSourceSimComponent

returns the new created Variable

public static FWSimVariable createOutputSimVariable(String aName, String
aDesc, String aRule, FWSimVariable.DATA_TYPE aDataType, String aUnit,
String aOutputFormat, Object aDefault, FWSimVariable.MODE_TYPE aModeType,
FWSimFieldContainer aTarget);

factory method to create an output (system-output - not component output) sim variable for net.simplace.simulation.util.FWSimVariable.CONTENT_TYPE out use method above.

• aName
• aDesc
• aRule
• aDataType
• aUnit
• aOutputFormat
• aDefault
• aModeType
• aTarget

returns the new created Variable

public static Object setValueAndDefault(Object aObject, FWSimVariable
aSimVariable, FWSimFieldContainer aSourceComponent)
throws SimValueOutOfRangeException, SimLinkInvalidException;

static factory implementation for setting unknown object type to a given FWSimVariable with type F

• aObject value
• aSimVariable to which the value is to be set
• aSourceComponent Component who wants to set this value - for checking purpose

returns the Value set with correct type

public static Object setValue(Object aObject, FWSimVariable aSimVariable,
FWSimFieldContainer aSourceComponent) throws SimValueOutOfRangeException,
SimLinkInvalidException;

static factory implementation for setting unknown object type to a given FWSimVariable with type F

• aObject value
• aSimVariable to which the value is to be set
• aSourceComponent Component who wants to set this value - for checking purpose

returns the Value set with correct type

public static Object transformDataType(String aObject,
FWSimVariable.DATA_TYPE aDataType) throws NumberFormatException;

static implementation of a data converter if possible use static setValue()-Method instead

• aObject
• aDataType

returns the transformed data object

public static String transformDataTypeToDB(FWSimVariable.DATA_TYPE aDataType);

transforms from Database type to net.simplace.simulation.util.FWSimVariable.DATA_TYPE

• aDataType used in database

returns the {@link DATA_TYPE}

public static FWSimVariable.DATA_TYPE transformDBDataType(String dataType);

transforms from Database type to net.simplace.simulation.util.FWSimVariable.DATA_TYPE

• dataType used in database

returns the {@link DATA_TYPE}

public static String transformJavaDataType(FWSimVariable.DATA_TYPE aDataType);

• aDataType

returns the Java Type Name

public static FWSimVariable.DATA_TYPE transformJavaDataType(String dataType);

transforms from written code style type to net.simplace.simulation.util.FWSimVariable.DATA_TYPE

• dataType used in java code

returns the {@link DATA_TYPE}

public static String transformContentType(FWSimVariable.CONTENT_TYPE
aContentType);

• aContentType

returns good toString information

public static Element createFormFields(FWSimVariable aVariable,
FWSimVariable.CONTENT_TYPE aComponentContentType, String aDescription,
String aFrequence, String aVisible, String aEnabled, boolean
aMultipleVarType);

• aVariable
• aComponentContentType
• aDescription
• aFrequence
• aVisible
• aEnabled
• aMultipleVarType

returns the FormElement

public static Element createFormFields(String aName, String aDescription,
String aContentTypeDefault, String aVisible, String aEnabled,
FWSimVariable.CONTENT_TYPE aComponentContentType);

• aName
• aDescription
• aContentTypeDefault
• aVisible
• aEnabled
• aComponentContentType

returns the FormElement

public static Element createMultipleFormElement(FWSimVariable aVariable,
String aName, String aDescription, String aVisible, String aEnabled,
String aContentType, String tModeType, boolean aModeNeeded, String
aFrequence, String tDataType, String tUnit, String tMax, String tMin,
String tRule, String tDesc, String tDefault, FWSimVariable.CONTENT_TYPE
aComponentContentType);

• aVariable
• aName
• aDescription
• aVisible
• aEnabled
• aContentType
• tModeType
• aModeNeeded
• aFrequence
• tDataType
• tUnit
• tMax
• tMin
• tRule
• tDesc
• tDefault
• aComponentContentType

returns the Form Element

public static Element createFormElement(FWSimVariable aVariable, String
aName, String aDescription, String aVisible, String aEnabled, String
aContentType, String aModeType, boolean aModeNeeded, String tDataType,
String tUnit, String tMax, String tMin, String tRule, String tDesc,
String tDefault, FWSimVariable.CONTENT_TYPE aComponentContentType);

• aVariable
• aName
• aDescription
• aVisible
• aEnabled
• aContentType
• aModeType
• aModeNeeded
• tDataType
• tUnit
• tMax
• tMin
• tRule
• tDesc
• tDefault
• aComponentContentType

returns the Form Element

public static FWSimVariable updateFields(FWSimVariable aVariable,
FWObservable aObservable) throws SimLinkInvalidException,
SimValueOutOfRangeException;

• aVariable
• aObservable

returns a new created sim variable

public void fillMetaDataFromSource(FWSimVarMap aVarMap);

• aVarMap

public boolean isNumber();


returns if Variable is a Number (int or double)

public boolean hasRule();


returns true if has a rule implemented

public boolean isDouble();


returns true if variable is double or array of double

public boolean isInt();


returns true if variable contains int or array of int

public boolean isBoolean();


returns true if variable is boolean

public boolean isString();


returns true if variable is char type

public boolean isDate();


returns true if variable is of date type

public boolean isArray();


returns true if variable is an array (int or double)

public boolean isOutputContent();


returns false if this is of type Input field: input or constant, else true

public boolean isInputContent();


returns true if this is of type Input field: input or constant, else false

public boolean isMeasData();


returns the isMeasData

public Boolean changed();


returns true the variable has been changed within last model day (0 to 1 days) or null if SimModel is null.

public String getDescription();


returns description of this variable

public FWSimVariable.DATA_TYPE getDataType();


returns the dataType

public FWSimVariable.CONTENT_TYPE getContentType();


returns the contentType

public FWSimVariable.MODE_TYPE getModeType();


returns the modeType

public Number getMax();


returns the max

public Number getMin();


returns the min

public Object getValue();

Use this method to get value out of the variable by default!
returns the value

public TreeMap forceDoubleMapValue() throws SimFieldTypeException;


returns a Tree Map with fixed order derived from a double array

public boolean forceBooleanValue(boolean aDefault);

forces a value to be returned as boolean !!! don't use this method for variables type Boolean !!!

• aDefault - taken if conversion is not successful

returns the boolean parameter - or the default

public double forceDoubleValue();

forces a value to be returned as double !!! don't use this method for variables type double !!!
returns the double parameter

public int forceIntValue();

forces a value to be returned as integer !!! don't use this method for variables type integer !!!
returns the integer parameter

public String forceStringValue();

forces a value to be returned as string !!! don't use this method for variables type string !!!
returns the string parameter

public void setDefaultValue();

replaces the value with the default - even if default is null value

public void reset();

replaces the value with the default - even if default is null value

public void setVarMap(FWSimVarMap aFwSimvarMap);

• aFwSimvarMap

public void setModeType(FWSimVariable.MODE_TYPE aModeType);

• aModeType

public void setRule(String aRule);

• aRule

public void changeDefaultValue(Object aValue);

changes default value

• aValue

public void setNull(FWSimFieldContainer aSource);

sets value to null: - checks for authentication - sets the current date when the value had changed last time - but only if SimModel was registered

• aSource Component who wants to set this value - for checking purpose

public void setValue(Object aValue, FWSimFieldContainer aSource);

standard set Value method: - checks for min and max limits - sets the current date when the value had changed last time - but only if SimModel was registered

• aValue the value to set
• aSource Component who wants to set this value - for checking purpose

public void setValue(FWSimVariable aVariable, FWSimFieldContainer aSource)
throws SimValueOutOfRangeException, SimLinkInvalidException;

standard set Value method: - checks for min and max limits - sets the current date when the value had changed last time - but only if SimModel was registered

• aVariable the value to set
• aSource Component who wants to set this value - for checking purpose

public void addValue(Object aValue, FWSimFieldContainer aSource)
throws SimValueOutOfRangeException;

standard set Value method: - checks for min and max limits - sets the current date when the value had changed last time - but only if SimModel was registered

• aValue the value to set
• aSource Component who wants to set this value - for checking purpose

public void addValue(FWSimVariable aVariable, FWSimFieldContainer aSource)
throws SimValueOutOfRangeException;

standard set Value method: - checks for min and max limits - sets the current date when the value had changed last time - but only if SimModel was registered

• aVariable the value to set
• aSource Component who wants to set this value - for checking purpose

public void multiplyValue(Number aValue, FWSimFieldContainer aSource)
throws SimValueOutOfRangeException;

standard set Value method: - checks for min and max limits - sets the current date when the value had changed last time - but only if SimModel was registered

• aValue the value to set
• aSource Component who wants to set this value - for checking purpose

public void setArrayValue(int aIndex, Number aValue, FWSimFieldContainer
aSource) throws SimValueOutOfRangeException, SimFieldTypeException;

special method for setting values to an array type variable

• aIndex of the array value should be set to
• aValue the value to set
• aSource Component who wants to set this value - for checking purpose

public String getName();


returns the name

public String getInternalName();


returns The Name of the Variable without the component Name

public String getUnit();


returns the unit

public String getFormat();


returns the format

public Object getFormatter();


returns the format

public String getStringUnit();


returns the unit

public Object getDefault();


returns the default

public String getRule();


returns the rule implemented in the variable

public Object evaluate(FWSimVarMap aVarMap);

• aVarMap

returns the result of the rule implemented in the variable

public Object evaluate();


returns the result of the rule implemented in the variable

public String toString(); // Overrides java.lang.Object

public String getStringValue();


returns a fromatted string value

public String toShortString();


returns the name as short string

public String toDebugString();


returns long debugging string value with all content of the variable

public Element toXML();


returns the Element of the variable with all needed values

public String getFieldName();


returns the short name without container information

public Integer[] getCount();


returns the count of items in the array

public Integer[] setCount(int aCount);

• aCount count of the params

returns the count of items in the array

public void setCount(Integer[] aArray);

• aArray of the counts

public String getPrefix();


returns the matching prefix

public String addPrefix(String aFieldName);

• aFieldName

returns the field name with matching prefix

public String check(FWSimVariable aOutputVar);

checking routine for 2 different SimVariables that are to be linked together

• aOutputVar

returns an error string - if string is null everything seems to be perfect!

public FWSimFieldContainer getSource();


returns the component registered as source component

public FWSimVarMap getVarMap();


returns the VarMap connected to this Variable

public void setSource(FWSimFieldContainer aComponent);

changing registered source component for this variable ! use this with care! should not be used by default

• aComponent

public void addOutputLink(String aFieldName) throws SimLinkInvalidException;

adding a link to the output-part of the link.

• aFieldName

public void addInputLink(String aFieldName) throws SimLinkInvalidException;

adding a link to the output-part of the link.

• aFieldName

public void removeLink(String aName);

• aName

public boolean isInputLinked() throws SimLinkInvalidException;


returns if is linked to another field as input

public boolean isOutputLinked();


returns if is linked to another field as output

public JexlRuleScript.COMPLEXITY getRuleComplexity();


returns the complexRule

public FWSimVariable clone(FWSimVarMap aVarMap);

deep clone of the SimVariable copying all fields to a new variable

• aVarMap

returns a new cloned {@link FWSimVariable} with identical meta data

public FWSimVariable deepClone(FWSimVarMap aVarMap);

• aVarMap

returns

public void setContentType(FWSimVariable.CONTENT_TYPE aContentType);

• aContentType

public void updateFields(Element aVarElement);

• aVarElement

public Element getFormComponentXML();


returns the generated form xml

public boolean equals(Object aObj); // Overrides java.lang.Object

public String toHTMLTablestring();


returns the HTML Table String