net.simplace.sim.control.FWSimulationControlContainer

The simulation generator creates for existing project ( net.simplace.sim.FWSimProject ) a range of simulations ( net.simplace.sim.FWSimSimulation ). This abstract class has 2 implementations: net.simplace.sim.control.generators.SimpleSimulationGenerator: Final class used for net.simplace.sim.FWSimProject.PROJECT_MODE.SIMULATION and net.simplace.sim.util.FWSimVariable.CONTENT_TYPE.sim. It just delivers the (few) simulations in the selected project. net.simplace.sim.control.generators.DefaultSimulationGenerator: Class used for all net.simplace.sim.FWSimProject.PROJECT_MODEs but net.simplace.sim.util.FWSimVariable.CONTENT_TYPE.res. Use this class to override and create own SimGenerator plug-ins. Method FWSimulationControlContainer has to be implemented in extending classes.


public abstract class FWSimulationControlContainer implements
net.simplace.sim.util.FWSimFieldContainer {
// Public Constructors
public FWSimulationControlContainer();
// Protected Constructors
protected FWSimulationControlContainer(Element aContainerElement,
FWSimSession aSession, HashMap aFieldMap);

// Protected Instance Variables
protected String iName;
protected FWSimulationControlCache iCache;
protected FWSimVarMap iControlMap;
protected FWSimVarMap iSimulationMap;
protected LinkedHashMap iFieldMap;
protected HashMap iInputMap;
protected Element iContainerElement;
protected LinkedHashMap iInputs;
protected HashMap iCals;
protected HashMap iParams;
protected FWSimSession iSession;
protected FWSimulationControlContainer.Constraint iConstraint;

// Public Instance Methods
public int getOrderNumber(); // From
net.simplace.sim.util.FWSimFieldContainer

public FWSimVariable.CONTENT_TYPE getContentType();
// From net.simplace.sim.util.FWSimFieldContainer

public void addVariable(FWSimVariable aVariable);
// From net.simplace.sim.util.FWSimFieldContainer

Add Variable to the Filed map. This should be called in implementing classes within the method "createVariables".
public FWSimVariable getVariable(String aKey)
throws SimFieldMissingException; // From
net.simplace.sim.util.FWSimFieldContainer


returns one SimVariable registered for given key
public void setPropertyValue(String aKey, Object aValue)
throws SimFieldMissingException;

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

Remove variable from FieldMap - handle with care!
public String getName(); // From net.simplace.sim.util.FWSimFieldContainer

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

returns the input variables from FieldMap
public ArrayList getOutputVariables(); // From
net.simplace.sim.util.FWSimFieldContainer


returns the OutputVariables from the FieldMap
public HashMap getFieldMap(); // From
net.simplace.sim.util.FWSimFieldContainer

public FWSimVarMap getVarMap(); // From
net.simplace.sim.util.FWSimFieldContainer

public Element toXML(); // 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 FWSimIOAdapter.FREQUENCE getFrequence(); // From
net.simplace.sim.util.FWSimFieldContainer

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

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


// Protected Instance Methods
protected void readInputCalAndConstraint();

protected abstract void init();

The model initialization function. Will be called only once, before running the model using process().
protected boolean evaluate(FWSimVarMap aVarMap, Boolean aDefault);

Evaluate whether aVarMap satisfies the given constraint
returns the boolean result of the evaluation

}



Extended by: FWSimulationGenerator, FWSimulationIterator, FWSimulationSelector