Package net.simplace.sim.components

Klasse FWSimpleSimComponent

java.lang.Object

net.simplace.sim.model.FWSimComponent

net.simplace.sim.components.FWSimpleSimComponent

Alle implementierten Schnittstellen:

IntegratableComponent, FWSimFieldContainer

public final class FWSimpleSimComponent
extends FWSimComponent
implements IntegratableComponent

Autor:

Andreas Enders

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen net.simplace.sim.model.FWSimComponent

FWSimComponent.TEST_STATE

Feldübersicht

Von Klasse geerbte Felder net.simplace.sim.model.FWSimComponent

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

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
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)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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()

Von Klasse geerbte Methoden 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

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

FWSimpleSimComponent

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

Parameter:

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)

Parameter:

aName -

aFieldMap -

aProcessAlgorithmsMap -

aIntegrateAlgorithmsMap -

aInputMap -

aSimComponentElement -

aVarMap -

aOrderNumber -

Methodendetails

createVariables

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

Beschreibung aus Klasse kopiert: FWSimComponent

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

Angegeben von:

createVariables in Schnittstelle FWSimFieldContainer

Angegeben von:

createVariables in Klasse FWSimComponent

Gibt zurück:

variables from the field map

Siehe auch:

• FWSimFieldContainer.createVariables()

bind

protected void bind()

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

Setzt außer Kraft:

bind in Klasse FWSimComponent

init

protected void init()

Beschreibung aus Klasse kopiert: FWSimComponent

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

Angegeben von:

init in Klasse FWSimComponent

process

protected void process()

Beschreibung aus Klasse kopiert: FWSimComponent

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

Angegeben von:

process in Klasse FWSimComponent

postIntegrate

public void postIntegrate()

Beschreibung aus Schnittstelle kopiert: IntegratableComponent

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

Angegeben von:

postIntegrate in Schnittstelle IntegratableComponent

getLinkedVariableNames

public Set<String> getLinkedVariableNames()

Gibt zurück:

the linkedVariableNames

getProcessAlgorithms

public LinkedList<FWSimVariable<?>> getProcessAlgorithms()

Gibt zurück:

the processAlgorithms

getIntegrateAlgorithms

public LinkedList<FWSimVariable<?>> getIntegrateAlgorithms()

Gibt zurück:

the integrateAlgorithms

showFields

public void showFields()

getEditFormXML

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

Angegeben von:

getEditFormXML in Schnittstelle FWSimFieldContainer

Setzt außer Kraft:

getEditFormXML in Klasse FWSimComponent

Parameter:

aEnabled -

Gibt zurück:

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

Siehe auch:

• FWSimFieldContainer.getEditFormXML(boolean)

toXML

public org.jdom2.Element toXML()

Angegeben von:

toXML in Schnittstelle FWSimFieldContainer

Setzt außer Kraft:

toXML in Klasse FWSimComponent

Gibt zurück:

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

Siehe auch:

• 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

Angegeben von:

fillTestVariables in Klasse FWSimComponent

Parameter:

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

Siehe auch:

• Ungültige Referenz

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

clone

protected FWSimComponent clone(FWSimVarMap aVarMap)

Angegeben von:

clone in Klasse FWSimComponent

Parameter:

aVarMap -

Gibt zurück:

the deep clone of the SimComponent