Package net.simplace.sim.components

Class FWAnalyticsSimComponent

java.lang.Object

net.simplace.sim.model.FWSimComponent

net.simplace.sim.components.FWAnalyticsSimComponent

All Implemented Interfaces:

FWSimFieldContainer

public final class FWAnalyticsSimComponent
extends FWSimComponent

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
FWAnalyticsSimComponent()
FWAnalyticsSimComponent(String aName, HashMap<String,FWSimVariable<?>> aFieldMap, HashMap<String,String> aInputMap, org.jdom2.Element aSimComponentElement, FWSimVarMap aVarMap, int aOrderNumber)
FWAnalyticsSimComponent(String aName, HashMap<String,FWSimVariable<?>> aFieldMap, LinkedList<FWSimVariable<Integer>> aProcessAlgorithmsMap, FWSimVariable<String[]> aHeader, FWSimVariable<Integer[]> aValues, HashMap<String,String> aInputMap, org.jdom2.Element aSimComponentElement, FWSimVarMap aVarMap, int aOrderNumber)

Method Summary

Modifier and Type	Method	Description
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.
protected void	init()	The model initialization function.
protected void	process()	The main model calculation function.
org.jdom2.Element	toXML()

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

addVariable, bind, checkCondition, createSimComponent, createSimComponent, createSimComponent, createSimComponent, doProcess, getConstantVariables, getContentType, getCreateFormXML, getDescription, getEditFormXML, 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

FWAnalyticsSimComponent

public FWAnalyticsSimComponent(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 -

FWAnalyticsSimComponent

public FWAnalyticsSimComponent()

FWAnalyticsSimComponent

public FWAnalyticsSimComponent(String aName,
 HashMap<String,FWSimVariable<?>> aFieldMap,
 LinkedList<FWSimVariable<Integer>> aProcessAlgorithmsMap,
 FWSimVariable<String[]> aHeader,
 FWSimVariable<Integer[]> aValues,
 HashMap<String,String> aInputMap,
 org.jdom2.Element aSimComponentElement,
 FWSimVarMap aVarMap,
 int aOrderNumber)

Parameters:

aName -

aFieldMap -

aProcessAlgorithmsMap -

aHeader -

aValues -

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()

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

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