Package net.simplace.sim.control

Class FWSimulationControlContainer

java.lang.Object

net.simplace.sim.control.FWSimulationControlContainer

All Implemented Interfaces:

FWSimFieldContainer

Direct Known Subclasses:

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 #generate(FWSimSimulation) has to be implemented in extending classes.

Author:

Andreas Enders

Field Summary

Fields

Modifier and Type	Field	Description
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

Constructor Summary

Constructors

Modifier	Constructor	Description
	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.

Method Summary

Modifier and Type	Method	Description
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()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.simplace.sim.util.FWSimFieldContainer

createVariables

Field Details

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

Constructor Details

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.

Parameters:

aContainerElement -

aSession -

aFieldMap -

Method Details

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

Specified by:

getOrderNumber in interface FWSimFieldContainer

Returns:

number in the order of Components

See Also:

• FWSimFieldContainer.getOrderNumber()

getContentType

public FWSimVariable.CONTENT_TYPE getContentType()

Specified by:

getContentType in interface FWSimFieldContainer

Returns:

number in the order of Components

See Also:

• 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".

Specified by:

addVariable in interface FWSimFieldContainer

Parameters:

aVariable -

evaluate

protected boolean evaluate(FWSimVarMap aVarMap,
 Boolean aDefault)

Evaluate whether aVarMap satisfies the given constraint

Parameters:

aVarMap -

aDefault -

Returns:

the boolean result of the evaluation

getVariable

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

Specified by:

getVariable in interface FWSimFieldContainer

Parameters:

aKey -

Returns:

one SimVariable registered for given key

Throws:

SimFieldMissingException - if Variable is Null

setPropertyValue

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

Parameters:

aKey -

aValue -

Throws:

SimFieldMissingException - if Variable is Null

removeVariable

public void removeVariable(String aID)

Remove variable from FieldMap - handle with care!

Specified by:

removeVariable in interface FWSimFieldContainer

See Also:

• FWSimFieldContainer.removeVariable(java.lang.String)

getName

public String getName()

Specified by:

getName in interface FWSimFieldContainer

Returns:

the Name of the component

See Also:

• FWSimFieldContainer.getName()

getInputVariables

public ArrayList<FWSimVariable<?>> getInputVariables()

returns the input variables from FieldMap

Specified by:

getInputVariables in interface FWSimFieldContainer

Returns:

FWSimVarables filtered - only input Variables

See Also:

• FWSimFieldContainer.getInputVariables()

getOutputVariables

public ArrayList<FWSimVariable<?>> getOutputVariables()

Specified by:

getOutputVariables in interface FWSimFieldContainer

Returns:

the OutputVariables from the FieldMap

See Also:

• FWSimFieldContainer.getOutputVariables()

addProcessTime

public void addProcessTime(long aProcessTime)

adds the processTime

Parameters:

aProcessTime -

getFieldMap

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

Specified by:

getFieldMap in interface FWSimFieldContainer

Returns:

whole field map as created in createVariables()

See Also:

• FWSimFieldContainer.getFieldMap()

getVarMap

public FWSimVarMap getVarMap()

Specified by:

getVarMap in interface FWSimFieldContainer

Returns:

number in the order of Components

toXML

public org.jdom2.Element toXML()

Specified by:

toXML in interface FWSimFieldContainer

Returns:

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

See Also:

• FWSimFieldContainer.toXML()

getCreateFormXML

public org.jdom2.Element getCreateFormXML()

Specified by:

getCreateFormXML in interface FWSimFieldContainer

Returns:

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

See Also:

• FWSimFieldContainer.getCreateFormXML()

getEditFormXML

public org.jdom2.Element getEditFormXML(boolean aEnabled)

Specified by:

getEditFormXML in interface FWSimFieldContainer

Returns:

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

See Also:

• FWSimFieldContainer.getEditFormXML(boolean)

getFrequence

public FWSimIOAdapter.FREQUENCE getFrequence()

Specified by:

getFrequence in interface FWSimFieldContainer

Returns:

the Frequence of the Container calling

checkCondition

public void checkCondition(Boolean aCheckResult,
 String aMessage)

Description copied from interface: FWSimFieldContainer

Called from inside the FWSimFieldContainer to log the initialization Errors.

Specified by:

checkCondition in interface FWSimFieldContainer

isConditionCheck

public boolean isConditionCheck()

Specified by:

isConditionCheck in interface FWSimFieldContainer