Package net.simplace.sim

Klasse FWSimSolution

java.lang.Object

net.simplace.sim.FWSimSolution

Alle implementierten Schnittstellen:

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

Autor:

Andreas Enders

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
String	CHECKER_CLASS	The individual class the simulation is checked with while running
String	CONNECTION_POOL_DEFAULT	name of default db connection pool

Konstruktorübersicht

Konstruktoren

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

Methodenübersicht

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

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

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

Konstruktordetails

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.

Parameter:

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.

Parameter:

aSimSolutionElement -

aVarMap -

aSolutionName -

Methodendetails

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.

Parameter:

aSimSolutionElement -

aVarMap -

aSolutionName -

getInterface

public FWSimInterface<?> getInterface(String aInterface)

Parameter:

aInterface -

Gibt zurück:

list of the project ids

setInterface

public void setInterface(FWSimInterface<?> aInterface)

Parameter:

aInterface -

getModelTemplate

public FWSimModel getModelTemplate()

Gibt zurück:

list of the project ids

getResourceAdapters

public Collection<FWSimInputAdapter> getResourceAdapters()

Gibt zurück:

a collection of all resource adapters including transformer adapters

getOutputAdapters

public ArrayList<FWSimOutputAdapter> getOutputAdapters()

Gibt zurück:

the Output Adapters

createVariables

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

returns the project field map

Angegeben von:

createVariables in Schnittstelle FWSimFieldContainer

Gibt zurück:

variables from the field map

Siehe auch:

• FWSimFieldContainer.createVariables()

addVariable

public void addVariable(FWSimVariable<?> aVariable)

Not clear if this is senseful - be careful using it

Angegeben von:

addVariable in Schnittstelle FWSimFieldContainer

Parameter:

aVariable -

Siehe auch:

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

getVariable

public FWSimVariable<?> getVariable(String aID)

returns variable from Projectlist

Angegeben von:

getVariable in Schnittstelle FWSimFieldContainer

Parameter:

aID -

Gibt zurück:

FWSimVariable for ID in Field Map

Siehe auch:

• FWSimFieldContainer.getVariable(java.lang.String)

removeVariable

public void removeVariable(String aID)

removes variable from project field list - be careful using it

Angegeben von:

removeVariable in Schnittstelle FWSimFieldContainer

Parameter:

aID -

Siehe auch:

• FWSimFieldContainer.removeVariable(java.lang.String)

getName

public String getName()

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

Angegeben von:

getName in Schnittstelle FWSimFieldContainer

Gibt zurück:

the Name of the component

Siehe auch:

• FWSimFieldContainer.getName()

getOrderNumber

public int getOrderNumber()

Angegeben von:

getOrderNumber in Schnittstelle FWSimFieldContainer

Gibt zurück:

number in the order of Components

Siehe auch:

• FWSimFieldContainer.getOrderNumber()

getAuthor

public String getAuthor()

Gibt zurück:

getDescription

public String getDescription()

Gibt zurück:

getTitle

public String getTitle()

Gibt zurück:

getSkipSimulation

public FWSimVariable<Boolean> getSkipSimulation()

Gibt zurück:

the skipSimulation

getOutputVariables

public Collection<FWSimVariable<?>> getOutputVariables()

Angegeben von:

getOutputVariables in Schnittstelle FWSimFieldContainer

Gibt zurück:

FWSimVarables filtered - only output Variables

Siehe auch:

• FWSimFieldContainer.getOutputVariables()

getInputVariables

public Collection<FWSimVariable<?>> getInputVariables()

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

Angegeben von:

getInputVariables in Schnittstelle FWSimFieldContainer

Gibt zurück:

FWSimVarables filtered - only input Variables

Siehe auch:

• FWSimFieldContainer.getInputVariables()

getFieldMap

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

returns the ProjectFieldMap

Angegeben von:

getFieldMap in Schnittstelle FWSimFieldContainer

Gibt zurück:

whole field map as created in createVariables()

Siehe auch:

• FWSimFieldContainer.getFieldMap()

toString

public String toString()

returns the name - always ProjectConstants

Setzt außer Kraft:

toString in Klasse Object

Siehe auch:

• Object.toString()

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

setCheckerClassName

public void setCheckerClassName(String aClassNameString)

Parameter:

aClassNameString - the checker class to perform checks

getCheckerClassName

public String getCheckerClassName()

Gibt zurück:

the level of checks performed

toXML

public org.jdom2.Element toXML()

Angegeben von:

toXML in Schnittstelle FWSimFieldContainer

Gibt zurück:

the SolutionElement

addLink

public void addLink(SimVarLink aSimVarLink)
             throws SimLinkInvalidException

Parameter:

aSimVarLink -

Löst aus:

SimLinkInvalidException

removeLink

public void removeLink(SimVarLink aSimVarLink)

Parameter:

aSimVarLink -

removeSimFieldContainer

public void removeSimFieldContainer(FWSimFieldContainer aFieldContainer)

Parameter:

aFieldContainer -

getFrequence

public FWSimIOAdapter.FREQUENCE getFrequence()

Angegeben von:

getFrequence in Schnittstelle FWSimFieldContainer

Gibt zurück:

the Frequence of the Container calling

Siehe auch:

• FWSimFieldContainer.getFrequence()

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)

getDynamicForm

public org.jdom2.Element getDynamicForm(FWObservable aObservable)

Parameter:

aObservable -

Gibt zurück:

the dynamic form element

update

public void update(FWObservable aFormObservable,
 Object aArg)

Beschreibung aus Schnittstelle kopiert: 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.

Angegeben von:

update in Schnittstelle FWObserver

Parameter:

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

Angegeben von:

getVarMap in Schnittstelle FWSimFieldContainer

Gibt zurück:

number in the order of Components

getSolutionElement

public org.jdom2.Element getSolutionElement()

Gibt zurück:

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