Package net.simplace.sim
Class FWSimProject
java.lang.Object
net.simplace.sim.FWSimProject
Projects signify the ensemble of several simulation runs, that have same resources (e.g. files, database)
but different settings in the
FWSimVariable
s. 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
Modifier and TypeClassDescriptionstatic enum
Variables can have the following value types -
Constructor Summary
ConstructorDescriptionFWSimProject
(String aProjectID, FWSimulationGenerator aGenerator, FWSimProject.PROJECT_MODE aProjectMode, FWSimulationControlCache aCache) -
Method Summary
Modifier and TypeMethodDescriptionboolean
getID()
int
static List<FWSimSimulation>
initProject
(List<FWSimSimulation> aSimulationList) initializes the Simulations with updating Simulations, resources and registering resources for enabling the memory output.final void
void
setSimulations
(List<FWSimSimulation> aSimulations) Manually set the simulations to the project - will not automatically be filled with the updateSimulations-MethodtoString()
org.jdom2.Element
toXML()
updateSimulations
(FWSimulationControlCache aControlCache)
-
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
Manually set the simulations to the project - will not automatically be filled with the updateSimulations-Method- Parameters:
aSimulations
-
-
getSimulations
- Returns:
- returns the simulations only, when they are manually set to the project before
-
getID
- Returns:
- the ID of the Project
-
getProjectMode
- Returns:
- s the project mode from upper enum
-
setProjectMode
- Parameters:
mode
- sets the project mode
-
toString
-
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
- Returns:
- the field map of the project
-
getSyncVarMap
- Returns:
-