Package net.simplace.sim

Class FWSimProject

java.lang.Object

net.simplace.sim.FWSimProject

public final class FWSimProject
extends Object

Projects signify the ensemble of several simulation runs, that have same resources (e.g. files, database) but different settings in the FWSimVariables. A project is defined in the (if provided) project.proj.xml-File. For Test mode no project file is provided. The project settings are taken from the solution (see constructor FWSimProject (FWSimSolution). Three types of simulations are supported: FWSimProject.PROJECT_MODE.SIMULATION: Test simulations without project or simple project runs for given project configuration FWSimProject.PROJECT_MODE.SENSITIVITY: Project creates List of FWSimSimulation via plug-in FWSimulationGenerator and runs them accordingly FWSimProject.PROJECT_MODE.CALIBRATION: Like SENSITIVITY but additional FWSimulationSelector selecting one simulation that fits most to the plug-in selector's algorithm. Additionally projects can be initialized by simple XML-Configuration or by resources given in the .proj.xml-File structure. The XML-Grammar is defined in FWSimProject.dtd and has to be met to make the project working.

Author:

Andreas Enders

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FWSimProject.PROJECT_MODE	Variables can have the following value types

Constructor Summary

Constructors

Constructor	Description
FWSimProject(String aProjectID, FWSimulationGenerator aGenerator, FWSimProject.PROJECT_MODE aProjectMode, FWSimulationControlCache aCache)

Method Summary

Modifier and Type	Method	Description
boolean	canUpdate()
HashMap<String,FWSimVariable<?>>	getFieldMap()
String	getID()
final FWSimProject.PROJECT_MODE	getProjectMode()
int	getSimulationCount()
List<FWSimSimulation>	getSimulations()
FWSimVarMap	getSyncVarMap()
static List<FWSimSimulation>	initProject(List<FWSimSimulation> aSimulationList)	initializes the Simulations with updating Simulations, resources and registering resources for enabling the memory output.
final void	setProjectMode(FWSimProject.PROJECT_MODE mode)
void	setSimulations(List<FWSimSimulation> aSimulations)	Manually set the simulations to the project - will not automatically be filled with the updateSimulations-Method
String	toString()
org.jdom2.Element	toXML()
List<FWSimSimulation>	updateSimulations(FWSimulationControlCache aControlCache)

Methods inherited from class java.lang.Object

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

Constructor Details

FWSimProject

public FWSimProject(String aProjectID,
 FWSimulationGenerator aGenerator,
 FWSimProject.PROJECT_MODE aProjectMode,
 FWSimulationControlCache aCache)

Parameters:

aProjectID -

aIterator -

aGenerator -

aSelector -

aProjectMode -

aCache -

Method Details

initProject

public static List<FWSimSimulation> initProject(List<FWSimSimulation> aSimulationList)
                                         throws Exception

initializes the Simulations with updating Simulations, resources and registering resources for enabling the memory output.

Parameters:

aSimulationList -

Returns:

the list of simulations that have been initialized

Throws:

Exception

toXML

public org.jdom2.Element toXML()

Returns:

the project Element

updateSimulations

public List<FWSimSimulation> updateSimulations(FWSimulationControlCache aControlCache)
                                        throws Exception

Parameters:

aControlCache -

aSelectedSimulation -

Returns:

the list of Simulations to be performed or null if project readily run.

Throws:

Exception

setSimulations

public void setSimulations(List<FWSimSimulation> aSimulations)

Manually set the simulations to the project - will not automatically be filled with the updateSimulations-Method

Parameters:

aSimulations -

getSimulations

public List<FWSimSimulation> getSimulations()

Returns:

returns the simulations only, when they are manually set to the project before

getID

public String getID()

Returns:

the ID of the Project

getProjectMode

public final FWSimProject.PROJECT_MODE getProjectMode()

Returns:

s the project mode from upper enum

setProjectMode

public final void setProjectMode(FWSimProject.PROJECT_MODE mode)

Parameters:

mode - sets the project mode

toString

public String toString()

Overrides:

toString in class Object

getSimulationCount

public int getSimulationCount()

Returns:

s the number of Simulations in this Project. If not initialized returns -1.

canUpdate

public boolean canUpdate()

Returns:

if the generator has more simulations in this project session run to be performed before selection

getFieldMap

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

Returns:

the field map of the project

getSyncVarMap

public FWSimVarMap getSyncVarMap()

Returns: