Package net.simplace.sim.model

Klasse FWSimComponentGroup

java.lang.Object

net.simplace.sim.model.FWSimComponent

net.simplace.sim.model.FWSimComponentGroup

Alle implementierten Schnittstellen:

IntegratableComponent, FWSimFieldContainer

public class FWSimComponentGroup
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

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final LinkedList<FWSimComponent>	iComponentList
protected final HashMap<String,String>	iComponentMapping
protected String	iConfigurationXMLPath
protected HashMap<String,String>	iInternalInputLinkMap
protected HashMap<String,String>	iInternalOutputLinkMap
protected boolean	iIsIntagratable
protected org.jdom2.Element	iSimGroupElement
protected String	iSimpleName

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

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

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
	FWSimComponentGroup()	Empty constructor reads the configuration of the component group
	FWSimComponentGroup(String aGroupName)	/** Empty constructor reads the configuration of the component group
protected	FWSimComponentGroup(String aName, HashMap<String,FWSimVariable<?>> aFieldMap, HashMap<String,String> aInputMap, org.jdom2.Element aSimComponentElement, FWSimVarMap aVarMap, int aOrderNumber, LinkedList<FWSimComponent> aComponentList, HashMap<String,String> aInternalInputLinkMap, HashMap<String,String> aInternalOutputLinkMap)	clone constructor

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected FWSimComponent	clone(FWSimVarMap aVarMap)
final void	create()	create will instantiate the sim components encapsulated in this class
final 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.
LinkedList<FWSimComponent>	getComponentList()
HashMap<String,String>	getComponentMapping()
HashMap<String,String>	getInternalInputLinkMap()
HashMap<String,String>	getInternalOutputLinkMap()
String	getSimpleName()
protected final void	init()	The model initialization function.
void	performInputLinks()	performs the internal input links between the internal and external SimComponents has to be called AFTER all external links are performed
protected void	performLinks(HashMap<String,String> aLinkMap)
void	performOutputLinks()	performs the internal output links between the internal and external SimComponents has to be called before all external links are performed
final void	postIntegrate()	The model integration function.
protected final void	process()	The main model calculation function.
protected void	readConfiguration()	reads the component list to the simulation element - should be called from readComponentList();
protected void	readConfiguration(String aConfigurationXMLPath)	reads the component list to the simulation element - should be called from readComponentList();
org.jdom2.Element	toDocXML()

Von Klasse geerbte Methoden 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, readInputs, removeVariable, reset, runComponentTest, setVariablesDefault, toComponentLinkingXML, toGroupXML, toOutputDefinitionXML, toResourcesDataXML, toResourcesDefinitionXML, toString, toXML, writeVarInfos

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

iComponentMapping

protected final HashMap<String,String> iComponentMapping

iComponentList

protected final LinkedList<FWSimComponent> iComponentList

iSimGroupElement

protected org.jdom2.Element iSimGroupElement

iInternalInputLinkMap

protected HashMap<String,String> iInternalInputLinkMap

iInternalOutputLinkMap

protected HashMap<String,String> iInternalOutputLinkMap

iConfigurationXMLPath

protected String iConfigurationXMLPath

iSimpleName

protected String iSimpleName

iIsIntagratable

protected boolean iIsIntagratable

Konstruktordetails

FWSimComponentGroup

public FWSimComponentGroup()

Empty constructor reads the configuration of the component group

FWSimComponentGroup

public FWSimComponentGroup(String aGroupName)

/** Empty constructor reads the configuration of the component group

FWSimComponentGroup

protected FWSimComponentGroup(String aName,
 HashMap<String,FWSimVariable<?>> aFieldMap,
 HashMap<String,String> aInputMap,
 org.jdom2.Element aSimComponentElement,
 FWSimVarMap aVarMap,
 int aOrderNumber,
 LinkedList<FWSimComponent> aComponentList,
 HashMap<String,String> aInternalInputLinkMap,
 HashMap<String,String> aInternalOutputLinkMap)

clone constructor

Parameter:

aName -

aFieldMap -

aInputMap -

aSimComponentElement -

aVarMap -

aOrderNumber -

aComponentList -

aInternalInputLinkMap -

aInternalOutputLinkMap -

aInternalLinkMap -

Methodendetails

readConfiguration

protected void readConfiguration()

reads the component list to the simulation element - should be called from readComponentList();

Parameter:

aConfigurationXMLPath -

readConfiguration

protected void readConfiguration(String aConfigurationXMLPath)

reads the component list to the simulation element - should be called from readComponentList();

Parameter:

aConfigurationXMLPath -

createVariables

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

getComponentList

public LinkedList<FWSimComponent> getComponentList()

Gibt zurück:

the componentList

getComponentMapping

public HashMap<String,String> getComponentMapping()

Gibt zurück:

the componentMapping

getInternalInputLinkMap

public HashMap<String,String> getInternalInputLinkMap()

Gibt zurück:

the internalInputLinkMap

getInternalOutputLinkMap

public HashMap<String,String> getInternalOutputLinkMap()

Gibt zurück:

the internalOutputLinkMap

performOutputLinks

public void performOutputLinks()
                        throws SimLinkInvalidException

performs the internal output links between the internal and external SimComponents has to be called before all external links are performed

Löst aus:

SimLinkInvalidException

performLinks

protected void performLinks(HashMap<String,String> aLinkMap)
                     throws SimLinkInvalidException

Setzt außer Kraft:

performLinks in Klasse FWSimComponent

Parameter:

aLinkMap - with key = destination and value = source!

Löst aus:

SimLinkInvalidException

performInputLinks

public void performInputLinks()
                       throws SimLinkInvalidException

performs the internal input links between the internal and external SimComponents has to be called AFTER all external links are performed

Löst aus:

SimLinkInvalidException

init

protected final 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 final 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 final 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

create

public final void create()
                  throws SimLinkInvalidException

create will instantiate the sim components encapsulated in this class

Löst aus:

SimLinkInvalidException

getSimpleName

public String getSimpleName()

toDocXML

public org.jdom2.Element toDocXML()

Setzt außer Kraft:

toDocXML in Klasse FWSimComponent

Gibt zurück:

Element of this document

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