net.simplace.simulation.util.FWSimVarMap

public HashMap getVarMap();


returns the parameterMap

public String getStringValue(String aKey);

• aKey

returns one parameter value for given key - null if key was not set

public Integer forceIntegerValue(String aKey);

• aKey

returns one parameter converted to Integer value for given key - null if key was not set or value not convertible

public Double forceDoubleValue(String aKey);

• aKey

returns one parameter converted to Double value for given key - null if key was not set or value not convertible

public boolean forceBooleanValue(String aParamKey);

used if generic type of the SimVariable is different but convertable to boolean. otherwise use getValue()!

• aParamKey

returns boolean value to be forced from other data type

public LocalDateTime forceDateValue(String aParamKey);

used if generic type of the SimVariable is different but convertable to date. otherwise use getValue()!

• aParamKey

returns the date that was retrieved from convert.

public Double[] forceDoubleArrayValue(String aString);

used if generic type of the SimVariable is different but convertible to double array. otherwise use getValue()!

• aString

returns the converted value

public TreeMap forceDoubleMapValue(String aKey);

used if generic type of the SimVariable is different but convertible to Double Map from array. otherwise use getValue()!

• aKey

returns the converted value

public Integer[] forceIntegerArrayValue(String aString);

used if generic type of the SimVariable is different but convertible to integer array. otherwise use getValue()!

• aString

returns the converted value

public String replaceParamTokens(String aString, Object aDefault);

Replacement of parameters in a string is performed.

• aString
• aDefault

returns the new String after replacement of the different variable tags

public Object getValue(String aKey);

• aKey

returns object value of the FWSimVariable registered with key

public Object getValue(String aKey, Object aDefault);

• aKey
• aDefault

returns object value of the FWSimVariable registered with key

public void setValue(String aKey, Object aValue, FWSimVariable.DATA_TYPE
aDataType, FWSimVariable.CONTENT_TYPE aContentType, FWSimFieldContainer
aSourceComponent) throws SimValueOutOfRangeException;

sets the value to the FWSimVariable. If Max or Min rule is not successfully evaluated SimValueOutOfRangeException is thrown. It is typeof RuntimeException and need not to be handled If FWSimVariable is not existing it will be created with a warn Message in log.

• aKey
• aValue
• aDataType
• aContentType
• aSourceComponent

public void initValue(String aKey, FWSimVariable aFWSimVariable);

new SimVariable is initialized and put to simVarMap

• aKey
• aFWSimVariable

public String getProjectID();


returns Identifier of this Functionality

public String getSimulationID();

Returns the number of observers of this Observable object.
returns the number of observers of this object.

public void setSimulationName(String aSimulationName);

• aSimulationName

public String getSimulationName();


returns simulation name

public Integer getSimulationNumber();


returns the simulation number

public FWSimSession getCurrentSession();


returns the current session

public String getCurrentDateString();

calculates statistics
returns Current model date toFormated string

public void calculateStatistics();

calculates statistics

public void setProjectID(String aProjectID);

• aProjectID

public void setSimulationNumber(Integer aSimulationNumber);

• aSimulationNumber

public void setCurrentSession(FWSimSession aFwSimSession);

• aFwSimSession

public void removeVariable(String aElement);

use with care! Variable might be needed

• aElement

public void putAllVariables(Map aVarMap);

number of variables are added to the VarMap

• aVarMap

public boolean isVariableAvailable(String aKey);

• aKey

returns s if a SimVariable is available

public boolean isSpinupPeriode();


returns s if system is in spin up period

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

simple output of VarMap

public void addLink(String aKey, FWSimVariable aVar, boolean performChecks)
throws SimLinkInvalidException;

Link between 2 SimVariables is added. If Link cannot be established a SimLinkInvalidException is thrown

• aKey of the target part of the link
• aVar with the source part of the link
• performChecks

public void removeLink(String aName, FWSimVariable aFwSimVariable);

• aName
• aFwSimVariable

public void initializeCurrentDate(LocalDateTime aDate);

Initializes the Current Date of the VarMap

• aDate

public void updateCurrentDate();

used to set the current model date to the VarMap

public LocalDateTime getCurrentDate();


returns the current model date

public void setCurrentDate(LocalDateTime aCurrentDate);

• aCurrentDate the current model date

public int getCurrentDOY();


returns current DayOfYear

public int getCurrentYear();


returns current Year

public int getCurrentDayOfMonth();


returns current Day of Month

public int getCurrentMonth();


returns current Month

public Boolean hasSimulationEnded();


returns the simulationEnd

public void setSimulationEnd();

sets the simulation end

public FWSimVarMap clone(); // Overrides java.lang.Object

deep clone on the SimVarMap - no references will stay same!

public HashMap getSimLinks();


returns a MultiHashMap containing all Links

public void reset();

set all variables to default values

public boolean hasSimVariable(String aRule);

• aKey

returns if the registered FWSimVariable is available for the given key!

public FWSimVariable getSimVariable(String aKey)
throws SimFieldMissingException;

• aKey

returns the registered FWSimVariable - need not be the one with the given key!

public String getValueToDatabaseString(String aSourceKey)
throws SimFieldMissingException;

mainly used for Date, DoubleArray and IntArray to get String format of the values

• aSourceKey

returns the value as converted database string

public Set getVariables(FWSimVariable.CONTENT_TYPE aContentType);

• aContentType

returns a list of Variables having this content type

public MultiHashMap getVariables(FWSimFieldContainer aContainer);

• aContentType

returns a list of Variables having this source container

public boolean has(String aName); // From
org.apache.commons.jexl2.JexlContext

Decorates the class as MapContext

public Object get(String aName); // From
org.apache.commons.jexl2.JexlContext

Decorates the class as MapContext

public void set(String aName, Object aValue); // From
org.apache.commons.jexl2.JexlContext

Decorates the class as MapContext