Package net.simplace.sim.components

Class FWSimpleSimComponent

java.lang.Object

net.simplace.sim.model.FWSimComponent

net.simplace.sim.components.FWSimpleSimComponent

All Implemented Interfaces:

IntegratableComponent, FWSimFieldContainer

public final class FWSimpleSimComponent
extends FWSimComponent
implements IntegratableComponent

Author:

Andreas Enders

Nested Class Summary

Nested classes/interfaces inherited from class net.simplace.sim.model.FWSimComponent

FWSimComponent.TEST_STATE

Field Summary

Fields inherited from class net.simplace.sim.model.FWSimComponent

iFieldMap, iFrequence, iInputMap, iJexlRule, iMasterComponentGroup, iName, iOrderNumber, isComponentGroup, iSimComponentElement, iSimModel, iVarMap

Constructor Summary

Constructors

Constructor	Description
FWSimpleSimComponent()
FWSimpleSimComponent(String aName, HashMap<String,FWSimVariable<?>> aFieldMap, HashMap<String,String> aInputMap, org.jdom2.Element aSimComponentElement, FWSimVarMap aVarMap, int aOrderNumber)
FWSimpleSimComponent(String aName, HashMap<String,FWSimVariable<?>> aFieldMap, LinkedList<FWSimVariable<?>> aProcessAlgorithmsMap, LinkedList<FWSimVariable<?>> aIntegrateAlgorithmsMap, HashMap<String,String> aInputMap, org.jdom2.Element aSimComponentElement, FWSimVarMap aVarMap, int aOrderNumber)

Method Summary

Modifier and Type	Method	Description
protected void	bind()	The model initialization function.
protected FWSimComponent	clone(FWSimVarMap aVarMap)
HashMap<String,FWSimVariable<?>>	createVariables()	called only once when the SimComponent is created.
HashMap<String,FWSimVariable<?>>	fillTestVariables(int aParamIndex, FWSimComponent.TEST_STATE aDefineOrCheck)	called for single component test to check the components algorithm.
final org.jdom2.Element	getEditFormXML(boolean aEnabled)
LinkedList<FWSimVariable<?>>	getIntegrateAlgorithms()
Set<String>	getLinkedVariableNames()
LinkedList<FWSimVariable<?>>	getProcessAlgorithms()
protected void	init()	The model initialization function.
void	postIntegrate()	The model integration function.
protected void	process()	The main model calculation function.
void	showFields()
org.jdom2.Element	toXML()

Methods inherited from class net.simplace.sim.model.FWSimComponent

addVariable, checkCondition, createSimComponent, createSimComponent, createSimComponent, createSimComponent, doProcess, getConstantVariables, getContentType, getCreateFormXML, getDescription, getFieldMap, getFrequence, getFrequenceRuleScript, getInputs, getInputVariables, getMasterComponentGroup, getName, getOrderNumber, getOutputVariables, getVariable, getVariableField, getVarMap, initialize, isConditionCheck, isVariableAvailable, performLinks, performLinks, readInputs, removeVariable, reset, runComponentTest, setVariablesDefault, toComponentLinkingXML, toDocXML, toGroupXML, toOutputDefinitionXML, toResourcesDataXML, toResourcesDefinitionXML, toString, writeVarInfos

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FWSimpleSimComponent

public FWSimpleSimComponent(String aName,
 HashMap<String,FWSimVariable<?>> aFieldMap,
 HashMap<String,String> aInputMap,
 org.jdom2.Element aSimComponentElement,
 FWSimVarMap aVarMap,
 int aOrderNumber)

Parameters:

aName -

aFieldMap -

aInputMap -

aSimComponentElement -

aVarMap -

aOrderNumber -

FWSimpleSimComponent

public FWSimpleSimComponent()

FWSimpleSimComponent

public FWSimpleSimComponent(String aName,
 HashMap<String,FWSimVariable<?>> aFieldMap,
 LinkedList<FWSimVariable<?>> aProcessAlgorithmsMap,
 LinkedList<FWSimVariable<?>> aIntegrateAlgorithmsMap,
 HashMap<String,String> aInputMap,
 org.jdom2.Element aSimComponentElement,
 FWSimVarMap aVarMap,
 int aOrderNumber)

Parameters:

aName -

aFieldMap -

aProcessAlgorithmsMap -

aIntegrateAlgorithmsMap -

aInputMap -

aSimComponentElement -

aVarMap -

aOrderNumber -

Method Details

createVariables

public HashMap<String,FWSimVariable<?>> createVariables()

Description copied from class: FWSimComponent

called only once when the SimComponent is created. Hereby the FieldMap is filled with the interfacing fields.

Specified by:

createVariables in interface FWSimFieldContainer

Specified by:

createVariables in class FWSimComponent

Returns:

variables from the field map

See Also:

• FWSimFieldContainer.createVariables()

bind

protected void bind()

The model initialization function. Will be called only once, before running the model using process().

Overrides:

bind in class FWSimComponent

init

protected void init()

Description copied from class: FWSimComponent

The model initialization function. Will be called only once, before running the model using process().

Specified by:

init in class FWSimComponent

process

protected void process()

Description copied from class: FWSimComponent

The main model calculation function. Is guaranteed to be called once per module-specific time step.

Specified by:

process in class FWSimComponent

postIntegrate

public void postIntegrate()

Description copied from interface: IntegratableComponent

The model integration function. Is guaranteed to be called once per module-specific time step.

Specified by:

postIntegrate in interface IntegratableComponent

getLinkedVariableNames

public Set<String> getLinkedVariableNames()

Returns:

the linkedVariableNames

getProcessAlgorithms

public LinkedList<FWSimVariable<?>> getProcessAlgorithms()

Returns:

the processAlgorithms

getIntegrateAlgorithms

public LinkedList<FWSimVariable<?>> getIntegrateAlgorithms()

Returns:

the integrateAlgorithms

showFields

public void showFields()

getEditFormXML

public final org.jdom2.Element getEditFormXML(boolean aEnabled)

Specified by:

getEditFormXML in interface FWSimFieldContainer

Overrides:

getEditFormXML in class FWSimComponent

Parameters:

aEnabled -

Returns:

a xml element with all the settings of this component()

See Also:

• FWSimFieldContainer.getEditFormXML(boolean)

toXML

public org.jdom2.Element toXML()

Specified by:

toXML in interface FWSimFieldContainer

Overrides:

toXML in class FWSimComponent

Returns:

a xml element with all the settings of this component()

See Also:

• FWSimFieldContainer.toXML()

fillTestVariables

public HashMap<String,FWSimVariable<?>> fillTestVariables(int aParamIndex,
 FWSimComponent.TEST_STATE aDefineOrCheck)

called for single component test to check the components algorithm. aParamIndex: Used to set up different test cases. Start with 0 - result check with 1 aso

Specified by:

fillTestVariables in class FWSimComponent

aDefineOrCheck - : Use TEST_STATE.DEFINE for defining the test default values and TEST_STATE.CHECK for the accepted results

See Also:

• net.simplace.sim.util.FWSimFieldContainer#fillTestVariables(int aParamIndex, TEST_STATE aDefineOrCheck)

clone

protected FWSimComponent clone(FWSimVarMap aVarMap)

Specified by:

clone in class FWSimComponent

Returns:

the deep clone of the SimComponent