net.simplace.simulation.FWSimProject

Projects signify the ensemble of several simulation runs, that have same resources (e.g. files, database) but different settings in the net.simplace.simulation.util.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 java.util.List of FWSimSimulation via plug-in net.simplace.simulation.control.FWSimulationGenerator and runs them accordingly FWSimProject.PROJECT_MODE.CALIBRATION: Like SENSITIVITY but additional net.simplace.simulation.control.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.


public final class FWSimProject {
// Public Constructors
public FWSimProject(String aProjectID, FWSimulationGenerator aGenerator,
FWSimProject.PROJECT_MODE aProjectMode);
public FWSimProject(FWSimSolution aSolution, Element aProjectElement,
FWSimulationGenerator aGenerator, FWSimulationSelector aSelector,
HashMap aConstantsMap, FWSimProject.PROJECT_MODE aProjectMode)
throws SimProjectException;

// Public Instance Methods
public List init() throws Exception;

initializes the Simulations with updating Simulations, resources and registering resources for enabling the memory output.
returns the list of simulations that have been initialized
public List initSimulations(List aSimulationList) throws Exception;

initializes the Simulations with updating Simulations, resources and registering resources for enabling the memory output.
returns the list of simulations that have been initialized
public Element toXML();


returns the project Element
public List updateSimulations(FWSimSimulation aSelectedSimulation);


returns the list of Simulations to be performed or null if project readily run.
public FWSimSimulation selectSimulation(List aSimulationsList);


returns the list of Simulations to be performed or null if project readily run.
public void setSimulations(List aSimulations);

Manually set the simulations to the project - will not automatically be filled with the updateSimulations-Method
public List getSimulations();


returns returns the simulations only, when they are manually set to the project before
public FWSimSimulation getSelectedSimulation();


returns returns the simulation only, when they are manually set to the project before
public String getID();


returns the ID of the Project
public Map getFieldMap();


returns s the field Map that contains constants and Variables
public Map getInternalFieldMap();


returns s the field Map that contains constants and Variables that are changed by project
public final FWSimProject.PROJECT_MODE getProjectMode();


returns s the project mode from upper enum
public final void setProjectMode(FWSimProject.PROJECT_MODE mode);

public String toString(); // Overrides java.lang.Object

public int getSimulationCount();


returns s the number of Simulations in this Project. If not initialized returns -1.
public boolean canSessionUpdate();


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

// Inner Classes
public static final class FWSimProject.PROJECT_MODE extends java.lang.Enum
}



Passed to: FWSimSession.runProject(), FWSimSession.runSimulations()