Package net.simplace.sim.control

Klasse FWSimulationControlContainer

java.lang.Object

net.simplace.sim.control.FWSimulationControlContainer

Alle implementierten Schnittstellen:

FWSimFieldContainer

Bekannte direkte Unterklassen:

FWSimulationGenerator, FWSimulationIterator, FWSimulationSelector

public abstract class FWSimulationControlContainer
extends Object
implements FWSimFieldContainer

The simulation generator creates for existing project ( FWSimProject ) a range of simulations ( FWSimSimulation ). This abstract class has 2 implementations: SimpleSimulationGenerator: Final class used for FWSimProject.PROJECT_MODE.SIMULATION and FWSimVariable.CONTENT_TYPE.sim. It just delivers the (few) simulations in the selected project. DefaultSimulationGenerator: Class used for all FWSimProject.PROJECT_MODEs but FWSimVariable.CONTENT_TYPE.res. Use this class to override and create own SimGenerator plug-ins. Method

Ungültige Referenz

#generate(FWSimSimulation)

has to be implemented in extending classes.

Autor:

Andreas Enders

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected FWSimulationControlCache	iCache	Cache reference to access data directly in the control process
protected HashMap<String,FWSimCalibrationVariable<?>>	iCals	Variables that are used as calibration variables that are interchanged between the generated simulations
protected net.simplace.sim.control.FWSimulationControlContainer.Constraint	iConstraint	Variables that are used as constraints of initiation of calibration variables
protected org.jdom2.Element	iContainerElement	Element the Simulation creator is configured from.
protected FWSimVarMap	iControlMap	Centrally used VarMap reference
protected LinkedHashMap<String,FWSimVariable<?>>	iFieldMap	initial field map as given by the createVariables()-Method in the SimComponent implementation
protected HashMap<String,String>	iInputMap	registered links of the SimComponent implementation
protected LinkedHashMap<String,FWSimVariable<?>>	iInputs	Variables that are used as inputs defining the needed configurations for running the generator
protected String	iName	Name of component
protected HashMap<String,FWSimVariable<?>>	iParams	Variables that are used as parameters of initiation of calibration variables
protected FWSimSession	iSession	the current used session
protected FWSimVarMap	iSimulationMap	Centrally used VarMap reference

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
	FWSimulationControlContainer()
protected	FWSimulationControlContainer(org.jdom2.Element aContainerElement, FWSimSession aSession, HashMap<String,FWSimVariable<?>> aFieldMap)	Default constructor of the abstract class that has to be called from overriding classes.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addProcessTime(long aProcessTime)	adds the processTime
void	addVariable(FWSimVariable<?> aVariable)	Add Variable to the Filed map.
void	checkCondition(Boolean aCheckResult, String aMessage)	Called from inside the FWSimFieldContainer to log the initialization Errors.
protected boolean	evaluate(FWSimVarMap aVarMap, Boolean aDefault)	Evaluate whether aVarMap satisfies the given constraint
FWSimVariable.CONTENT_TYPE	getContentType()
org.jdom2.Element	getCreateFormXML()
org.jdom2.Element	getEditFormXML(boolean aEnabled)
HashMap<String,FWSimVariable<?>>	getFieldMap()
FWSimIOAdapter.FREQUENCE	getFrequence()
ArrayList<FWSimVariable<?>>	getInputVariables()	returns the input variables from FieldMap
String	getName()
int	getOrderNumber()
ArrayList<FWSimVariable<?>>	getOutputVariables()
FWSimVariable<?>	getVariable(String aKey)
FWSimVarMap	getVarMap()
protected abstract void	init()	The model initialization function.
boolean	isConditionCheck()
protected void	readInputCalAndConstraint()
void	removeVariable(String aID)	Remove variable from FieldMap - handle with care!
void	setPropertyValue(String aKey, Object aValue)
org.jdom2.Element	toXML()

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden net.simplace.sim.util.FWSimFieldContainer

createVariables

Felddetails

iName

protected String iName

Name of component

iCache

protected FWSimulationControlCache iCache

Cache reference to access data directly in the control process

iControlMap

protected FWSimVarMap iControlMap

Centrally used VarMap reference

iSimulationMap

protected FWSimVarMap iSimulationMap

Centrally used VarMap reference

iFieldMap

protected LinkedHashMap<String,FWSimVariable<?>> iFieldMap

initial field map as given by the createVariables()-Method in the SimComponent implementation

iInputMap

protected HashMap<String,String> iInputMap

registered links of the SimComponent implementation

iContainerElement

protected org.jdom2.Element iContainerElement

Element the Simulation creator is configured from.

iInputs

protected LinkedHashMap<String,FWSimVariable<?>> iInputs

Variables that are used as inputs defining the needed configurations for running the generator

iCals

protected HashMap<String,FWSimCalibrationVariable<?>> iCals

Variables that are used as calibration variables that are interchanged between the generated simulations

iParams

protected HashMap<String,FWSimVariable<?>> iParams

Variables that are used as parameters of initiation of calibration variables

iSession

protected FWSimSession iSession

the current used session

iConstraint

protected net.simplace.sim.control.FWSimulationControlContainer.Constraint iConstraint

Variables that are used as constraints of initiation of calibration variables

Konstruktordetails

FWSimulationControlContainer

public FWSimulationControlContainer()

FWSimulationControlContainer

protected FWSimulationControlContainer(org.jdom2.Element aContainerElement,
 FWSimSession aSession,
 HashMap<String,FWSimVariable<?>> aFieldMap)

Default constructor of the abstract class that has to be called from overriding classes.

Parameter:

aContainerElement -

aSession -

aFieldMap -

Methodendetails

readInputCalAndConstraint

protected void readInputCalAndConstraint()

init

protected abstract void init()

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

getOrderNumber

public int getOrderNumber()

Angegeben von:

getOrderNumber in Schnittstelle FWSimFieldContainer

Gibt zurück:

number in the order of Components

Siehe auch:

• FWSimFieldContainer.getOrderNumber()

getContentType

public FWSimVariable.CONTENT_TYPE getContentType()

Angegeben von:

getContentType in Schnittstelle FWSimFieldContainer

Gibt zurück:

number in the order of Components

Siehe auch:

• FWSimFieldContainer.getContentType()

addVariable

public void addVariable(FWSimVariable<?> aVariable)

Add Variable to the Filed map. This should be called in implementing classes within the method "createVariables".

Angegeben von:

addVariable in Schnittstelle FWSimFieldContainer

Parameter:

aVariable -

evaluate

protected boolean evaluate(FWSimVarMap aVarMap,
 Boolean aDefault)

Evaluate whether aVarMap satisfies the given constraint

Parameter:

aVarMap -

aDefault -

Gibt zurück:

the boolean result of the evaluation

getVariable

public FWSimVariable<?> getVariable(String aKey)
                             throws SimFieldMissingException

Angegeben von:

getVariable in Schnittstelle FWSimFieldContainer

Parameter:

aKey -

Gibt zurück:

one SimVariable registered for given key

Löst aus:

SimFieldMissingException - if Variable is Null

setPropertyValue

public void setPropertyValue(String aKey,
 Object aValue)
                      throws SimFieldMissingException

Parameter:

aKey -

aValue -

Löst aus:

SimFieldMissingException - if Variable is Null

removeVariable

public void removeVariable(String aID)

Remove variable from FieldMap - handle with care!

Angegeben von:

removeVariable in Schnittstelle FWSimFieldContainer

Parameter:

aID -

Siehe auch:

• FWSimFieldContainer.removeVariable(java.lang.String)

getName

public String getName()

Angegeben von:

getName in Schnittstelle FWSimFieldContainer

Gibt zurück:

the Name of the component

Siehe auch:

• FWSimFieldContainer.getName()

getInputVariables

public ArrayList<FWSimVariable<?>> getInputVariables()

returns the input variables from FieldMap

Angegeben von:

getInputVariables in Schnittstelle FWSimFieldContainer

Gibt zurück:

FWSimVarables filtered - only input Variables

Siehe auch:

• FWSimFieldContainer.getInputVariables()

getOutputVariables

public ArrayList<FWSimVariable<?>> getOutputVariables()

Angegeben von:

getOutputVariables in Schnittstelle FWSimFieldContainer

Gibt zurück:

the OutputVariables from the FieldMap

Siehe auch:

• FWSimFieldContainer.getOutputVariables()

addProcessTime

public void addProcessTime(long aProcessTime)

adds the processTime

Parameter:

aProcessTime -

getFieldMap

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

Angegeben von:

getFieldMap in Schnittstelle FWSimFieldContainer

Gibt zurück:

whole field map as created in createVariables()

Siehe auch:

• FWSimFieldContainer.getFieldMap()

getVarMap

public FWSimVarMap getVarMap()

Angegeben von:

getVarMap in Schnittstelle FWSimFieldContainer

Gibt zurück:

number in the order of Components

toXML

public org.jdom2.Element toXML()

Angegeben von:

toXML in Schnittstelle FWSimFieldContainer

Gibt zurück:

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

Siehe auch:

• FWSimFieldContainer.toXML()

getCreateFormXML

public org.jdom2.Element getCreateFormXML()

Angegeben von:

getCreateFormXML in Schnittstelle FWSimFieldContainer

Gibt zurück:

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

Siehe auch:

• FWSimFieldContainer.getCreateFormXML()

getEditFormXML

public org.jdom2.Element getEditFormXML(boolean aEnabled)

Angegeben von:

getEditFormXML in Schnittstelle FWSimFieldContainer

Parameter:

aEnabled -

Gibt zurück:

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

Siehe auch:

• FWSimFieldContainer.getEditFormXML(boolean)

getFrequence

public FWSimIOAdapter.FREQUENCE getFrequence()

Angegeben von:

getFrequence in Schnittstelle FWSimFieldContainer

Gibt zurück:

the Frequence of the Container calling

checkCondition

public void checkCondition(Boolean aCheckResult,
 String aMessage)

Beschreibung aus Schnittstelle kopiert: FWSimFieldContainer

Called from inside the FWSimFieldContainer to log the initialization Errors.

Angegeben von:

checkCondition in Schnittstelle FWSimFieldContainer

Parameter:

aCheckResult -

aMessage -

isConditionCheck

public boolean isConditionCheck()

Angegeben von:

isConditionCheck in Schnittstelle FWSimFieldContainer