net.simplace.sim.FWSimSolution

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


public final class FWSimSolution implements
net.simplace.sim.util.FWSimFieldContainer, net.simplace.core.FWObserver {
// Public Constructors
public FWSimSolution(FWSimSession aSession, FWSimSolution aFwSimSolution);
public FWSimSolution(Element aSimSolutionElement, FWSimVarMap aVarMap,
String aSolutionName);

// Public Instance Variables
public String CONNECTION_POOL_DEFAULT;
public FWCheckHelper.CHECK_LEVEL CHECK_LEVEL;
public String CHECKER_CLASS;

// Public Instance Methods
public void init();

After standard constructor taking a solution org.jdom.Element and a net.simplace.sim.util.FWSimVarMap call order: initInterfaces initConstants initResources initModel initOutput After Project initialization the different solution parts are set up to a working state.
public FWSimInterface getInterface(String aInterface);


returns list of the project ids
public void setInterface(FWSimInterface aInterface);

public FWSimModel getModelTemplate();


returns list of the project ids
public Collection getResourceAdapters();


returns a collection of all resource adapters including transformer adapters
public ArrayList getOutputAdapters();


returns the Output Adapters
public HashMap createVariables(); // From
net.simplace.sim.util.FWSimFieldContainer

returns the project field map
public void addVariable(FWSimVariable aVariable);
// From net.simplace.sim.util.FWSimFieldContainer

Not clear if this is senseful - be careful using it
public FWSimVariable getVariable(String aID); // From
net.simplace.sim.util.FWSimFieldContainer

returns variable from Projectlist
public void removeVariable(String aID); // From
net.simplace.sim.util.FWSimFieldContainer

removes variable from project field list - be careful using it
public String getName(); // From net.simplace.sim.util.FWSimFieldContainer

Always returns name: ProjectConstants - mostly used for module overview page
public int getOrderNumber(); // From
net.simplace.sim.util.FWSimFieldContainer

public String getAuthor();


returns
public String getDescription();


returns
public String getTitle();


returns
public Collection getOutputVariables(); // From
net.simplace.sim.util.FWSimFieldContainer

public Collection getInputVariables(); // From
net.simplace.sim.util.FWSimFieldContainer

returns empty ArrayList while there are no input variables for this object
public HashMap getFieldMap(); // From
net.simplace.sim.util.FWSimFieldContainer

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

returns the name - always ProjectConstants
public FWSimVariable.CONTENT_TYPE getContentType();
// From net.simplace.sim.util.FWSimFieldContainer

public FWCheckHelper.CHECK_LEVEL getCheckLevel();


returns the level of checks performed
public void setCheckLevel(FWCheckHelper.CHECK_LEVEL aCheckLevel);

public void setCheckerClassName(String aClassNameString);

public String getCheckerClassName();


returns the level of checks performed
public Element toXML(); // From net.simplace.sim.util.FWSimFieldContainer


returns the SolutionElement
public void addLink(SimVarLink aSimVarLink) throws SimLinkInvalidException;

public void removeLink(SimVarLink aSimVarLink);

public void removeSimFieldContainer(FWSimFieldContainer aFieldContainer);

public FWSimIOAdapter.FREQUENCE getFrequence(); // From
net.simplace.sim.util.FWSimFieldContainer

public Element getCreateFormXML(); // From
net.simplace.sim.util.FWSimFieldContainer

public Element getEditFormXML(boolean aEnabled); // From
net.simplace.sim.util.FWSimFieldContainer

public Element getDynamicForm(FWObservable aObservable);


returns the dynamic form element
public void update(FWObservable aFormObservable, Object aArg);
// From net.simplace.core.FWObserver

public void showDescription();

Shows the description of the solution in external browser
public FWSimVarMap getVarMap(); // From
net.simplace.sim.util.FWSimFieldContainer

public Element getSolutionElement();


returns
public void checkCondition(Boolean aCheckResult, String aMessage);
// From net.simplace.sim.util.FWSimFieldContainer

public boolean isConditionCheck(); // From
net.simplace.sim.util.FWSimFieldContainer


}



Passed to: FWSimSession.FWSimSession(), FWSimSolution(), net.simplace.sim.io.resources.FWSimResourceManager.referenceKeys(), FWSimEngine.registerSolution(), net.simplace.client.sim.graphpanel.SimEnvGraphPanel()



Returned by: net.simplace.client.sim.graphpanel.SimEnvGraphPanel.getSimSolution(), FWSimSession.getSolution()