Package net.simplace.sim

Class FWSimSolution

java.lang.Object

net.simplace.sim.FWSimSolution

All Implemented Interfaces:

FWObserver, FWSimFieldContainer

public final class FWSimSolution
extends Object
implements FWSimFieldContainer, FWObserver

Contains whole information about: Model-Template Interfaces for external data read and write Resource parameters Output configuration Constant Values Within the Solution creation process the different parts of the simulation session are configured to a default configuration. Project simulations can overwrite these configurations namely interfaces and outputs. The constant- or input variables are initialized in a hierarchical setting: Solution constants overwrite defaults Project constants overwrite solution constants Simulation constants overwrite project constants IO-relations overwrite simulation constants (e.g. initial variables) in first simulation step The solution contains as main part the model with its components and links between these and the resources and outputs. Structure of solution.sol.xml file has to refer to the grammar of SimSolution.dtd

Author:

Andreas Enders

Field Summary

Fields

Modifier and Type	Field	Description
String	CHECKER_CLASS	The individual class the simulation is checked with while running
String	CONNECTION_POOL_DEFAULT	name of default db connection pool

Constructor Summary

Constructors

Constructor	Description
FWSimSolution(FWSimSession aSession, FWSimSolution aFwSimSolution)	Standard constructor taking a solution Element and a FWSimVarMap After Project initialization the different solution parts are set up to a working state.
FWSimSolution(org.jdom2.Element aSimSolutionElement, FWSimVarMap aVarMap, String aSolutionName)	Standard constructor taking a solution Element and a FWSimVarMap After Project initialization the different solution parts are set up to a working state.

Method Summary

Modifier and Type	Method	Description
void	addLink(SimVarLink aSimVarLink)
void	addVariable(FWSimVariable<?> aVariable)	Not clear if this is senseful - be careful using it
void	checkCondition(Boolean aCheckResult, String aMessage)	Called from inside the FWSimFieldContainer to log the initialization Errors.
HashMap<String,FWSimVariable<?>>	createVariables()	returns the project field map
String	getAuthor()
String	getCheckerClassName()
FWSimVariable.CONTENT_TYPE	getContentType()
org.jdom2.Element	getCreateFormXML()
String	getDescription()
org.jdom2.Element	getDynamicForm(FWObservable aObservable)
org.jdom2.Element	getEditFormXML(boolean aEnabled)
HashMap<String,FWSimVariable<?>>	getFieldMap()	returns the ProjectFieldMap
FWSimIOAdapter.FREQUENCE	getFrequence()
Collection<FWSimVariable<?>>	getInputVariables()	returns empty ArrayList while there are no input variables for this object
FWSimInterface<?>	getInterface(String aInterface)
FWSimModel	getModelTemplate()
String	getName()	Always returns name: ProjectConstants - mostly used for module overview page
int	getOrderNumber()
ArrayList<FWSimOutputAdapter>	getOutputAdapters()
Collection<FWSimVariable<?>>	getOutputVariables()
Collection<FWSimInputAdapter>	getResourceAdapters()
FWSimVariable<Boolean>	getSkipSimulation()
org.jdom2.Element	getSolutionElement()
String	getTitle()
FWSimVariable<?>	getVariable(String aID)	returns variable from Projectlist
FWSimVarMap	getVarMap()
void	init()	After standard constructor taking a solution Element and a FWSimVarMap call order: initInterfaces initConstants initResources initModel initOutput After Project initialization the different solution parts are set up to a working state.
boolean	isConditionCheck()
void	removeLink(SimVarLink aSimVarLink)
void	removeSimFieldContainer(FWSimFieldContainer aFieldContainer)
void	removeVariable(String aID)	removes variable from project field list - be careful using it
void	setCheckerClassName(String aClassNameString)
void	setInterface(FWSimInterface<?> aInterface)
void	showDescription()	Shows the description of the solution in external browser
String	toString()	returns the name - always ProjectConstants
org.jdom2.Element	toXML()
void	update(FWObservable aFormObservable, Object aArg)	This method is called whenever the observed object is changed.

Methods inherited from class java.lang.Object

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

Field Details

CONNECTION_POOL_DEFAULT

public String CONNECTION_POOL_DEFAULT

name of default db connection pool

CHECKER_CLASS

public String CHECKER_CLASS

The individual class the simulation is checked with while running

Constructor Details

FWSimSolution

public FWSimSolution(FWSimSession aSession,
 FWSimSolution aFwSimSolution)

Standard constructor taking a solution Element and a FWSimVarMap After Project initialization the different solution parts are set up to a working state.

Parameters:

aSession -

aFwSimSolution -

FWSimSolution

public FWSimSolution(org.jdom2.Element aSimSolutionElement,
 FWSimVarMap aVarMap,
 String aSolutionName)

Standard constructor taking a solution Element and a FWSimVarMap After Project initialization the different solution parts are set up to a working state.

Parameters:

aSimSolutionElement -

aVarMap -

aSolutionName -

Method Details

init

public void init()

After standard constructor taking a solution Element and a FWSimVarMap call order: initInterfaces initConstants initResources initModel initOutput After Project initialization the different solution parts are set up to a working state.

Parameters:

aSimSolutionElement -

aVarMap -

aSolutionName -

getInterface

public FWSimInterface<?> getInterface(String aInterface)

Parameters:

aInterface -

Returns:

list of the project ids

setInterface

public void setInterface(FWSimInterface<?> aInterface)

Parameters:

aInterface -

getModelTemplate

public FWSimModel getModelTemplate()

Returns:

list of the project ids

getResourceAdapters

public Collection<FWSimInputAdapter> getResourceAdapters()

Returns:

a collection of all resource adapters including transformer adapters

getOutputAdapters

public ArrayList<FWSimOutputAdapter> getOutputAdapters()

Returns:

the Output Adapters

createVariables

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

returns the project field map

Specified by:

createVariables in interface FWSimFieldContainer

Returns:

variables from the field map

See Also:

• FWSimFieldContainer.createVariables()

addVariable

public void addVariable(FWSimVariable<?> aVariable)

Not clear if this is senseful - be careful using it

Specified by:

addVariable in interface FWSimFieldContainer

See Also:

• FWSimFieldContainer.addVariable(net.simplace.sim.util.FWSimVariable)

getVariable

public FWSimVariable<?> getVariable(String aID)

returns variable from Projectlist

Specified by:

getVariable in interface FWSimFieldContainer

Returns:

FWSimVariable for ID in Field Map

See Also:

• FWSimFieldContainer.getVariable(java.lang.String)

removeVariable

public void removeVariable(String aID)

removes variable from project field list - be careful using it

Specified by:

removeVariable in interface FWSimFieldContainer

See Also:

• FWSimFieldContainer.removeVariable(java.lang.String)

getName

public String getName()

Always returns name: ProjectConstants - mostly used for module overview page

Specified by:

getName in interface FWSimFieldContainer

Returns:

the Name of the component

See Also:

• FWSimFieldContainer.getName()

getOrderNumber

public int getOrderNumber()

Specified by:

getOrderNumber in interface FWSimFieldContainer

Returns:

number in the order of Components

See Also:

• FWSimFieldContainer.getOrderNumber()

getAuthor

public String getAuthor()

Returns:

getDescription

public String getDescription()

Returns:

getTitle

public String getTitle()

Returns:

getSkipSimulation

public FWSimVariable<Boolean> getSkipSimulation()

Returns:

the skipSimulation

getOutputVariables

public Collection<FWSimVariable<?>> getOutputVariables()

Specified by:

getOutputVariables in interface FWSimFieldContainer

Returns:

FWSimVarables filtered - only output Variables

See Also:

• FWSimFieldContainer.getOutputVariables()

getInputVariables

public Collection<FWSimVariable<?>> getInputVariables()

returns empty ArrayList while there are no input variables for this object

Specified by:

getInputVariables in interface FWSimFieldContainer

Returns:

FWSimVarables filtered - only input Variables

See Also:

• FWSimFieldContainer.getInputVariables()

getFieldMap

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

returns the ProjectFieldMap

Specified by:

getFieldMap in interface FWSimFieldContainer

Returns:

whole field map as created in createVariables()

See Also:

• FWSimFieldContainer.getFieldMap()

toString

public String toString()

returns the name - always ProjectConstants

Overrides:

toString in class Object

See Also:

• Object.toString()

getContentType

public FWSimVariable.CONTENT_TYPE getContentType()

Specified by:

getContentType in interface FWSimFieldContainer

Returns:

number in the order of Components

See Also:

• FWSimFieldContainer.getContentType()

setCheckerClassName

public void setCheckerClassName(String aClassNameString)

Parameters:

aClassNameString - the checker class to perform checks

getCheckerClassName

public String getCheckerClassName()

Returns:

the level of checks performed

toXML

public org.jdom2.Element toXML()

Specified by:

toXML in interface FWSimFieldContainer

Returns:

the SolutionElement

addLink

public void addLink(SimVarLink aSimVarLink)
             throws SimLinkInvalidException

Parameters:

aSimVarLink -

Throws:

SimLinkInvalidException

removeLink

public void removeLink(SimVarLink aSimVarLink)

Parameters:

aSimVarLink -

removeSimFieldContainer

public void removeSimFieldContainer(FWSimFieldContainer aFieldContainer)

Parameters:

aFieldContainer -

getFrequence

public FWSimIOAdapter.FREQUENCE getFrequence()

Specified by:

getFrequence in interface FWSimFieldContainer

Returns:

the Frequence of the Container calling

See Also:

• FWSimFieldContainer.getFrequence()

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)

getDynamicForm

public org.jdom2.Element getDynamicForm(FWObservable aObservable)

Parameters:

aObservable -

Returns:

the dynamic form element

update

public void update(FWObservable aFormObservable,
 Object aArg)

Description copied from interface: FWObserver

This method is called whenever the observed object is changed. An application calls an Observable object's notifyObservers method to have all the object's observers notified of the change.

Specified by:

update in interface FWObserver

Parameters:

aFormObservable - the observable object.

aArg - an argument passed to the notifyObservers method.

showDescription

public void showDescription()

Shows the description of the solution in external browser

getVarMap

public FWSimVarMap getVarMap()

Specified by:

getVarMap in interface FWSimFieldContainer

Returns:

number in the order of Components

getSolutionElement

public org.jdom2.Element getSolutionElement()

Returns:

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