net.simplace.sim.control.FWExchangeComponent



public abstract class FWExchangeComponent implements
net.simplace.sim.util.FWSimFieldContainer {
// Protected Constructors
protected FWExchangeComponent();
protected FWExchangeComponent(String aName, HashMap aFieldMap, HashMap
aInputMap, Element aSimComponentElement, FWSimVarMap aControlVarMap,
ArrayList aVarMaps, int aOrderNumber);

// Protected Instance Variables
protected String iName;
protected FWSimVarMap iControlVarMap;
protected HashMap iFieldMap;
protected HashMap iInputMap;
protected ArrayList iVarMaps;
protected Element iExchangeComponentElement;
protected int iOrderNumber;
protected FWSimIOAdapter.FREQUENCE iFrequence;
protected JexlRuleScript iSyncScript;

// Class Methods
public static FWExchangeComponent createExchangeComponent(Element
aExchangeComponentElement, FWSimVarMap aControlVarMap, ArrayList
aVarMaps, int aOrderNumber) throws SimLinkInvalidException;

factory method creating an ExchangeComponent
returns newly created FWExchangeComponent
public static FWExchangeComponent createExchangeComponent(String tName,
FWSimVarMap aControlVarMap, ArrayList aVarMaps, int aOrderNumber)
throws SimLinkInvalidException;


returns the created FWExchangeComponent
public static FWExchangeComponent createExchangeComponent(String aClassname);


returns the newly created sim component

// Public Instance Methods
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 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


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


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

public String writeVarInfos(String aFilePath);

Writes the varInfos to a given FilePath.
returns the string result
public void initialize();

The model initialization function. Will be called only once, before running the model using process().
public abstract HashMap createVariables(); // From
net.simplace.sim.util.FWSimFieldContainer

called only once when the SimComponent is created. Hereby the FieldMap is filled with the interfacing fields.
public void performLinks() throws SimLinkInvalidException;

links like given in the input part of the SimComponent configuration are performed. This is done only while model creation.
public Map getInputs();


returns the map of the input relations. key is given without the name of the component.
public String toString(); // Overrides java.lang.Object

Name of the Component
public Element toDocXML();


returns Element of this document
public Element toXML(); // From net.simplace.sim.util.FWSimFieldContainer

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

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

public void showFields();

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

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

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

public String getDescription();


returns the description including title

// Protected Instance Methods
protected FWSimVariable getVariableField(String aKey);


returns the FWSimVariable from FieldMap (not from the VarMap!)
protected boolean isVariableAvailable(String aString);


returns if Variable is available in VarMap
protected HashMap readInputs(Element aSimComponentElement);


returns HashMap of inputs
protected void bind();

The model initialization function. Will be called only once, before running the model using process().
protected abstract void init();

The model initialization function. Will be called only once, before running the model using process().
protected void performLinks(HashMap aLinkMap) throws SimLinkInvalidException;

protected void reset(FWSimVarMap aVarMap);

protected abstract void process();

The main model calculation function. Is guaranteed to be called once per module-specific time step.
protected abstract FWExchangeComponent clone(FWSimVarMap aVarMap);


returns the deep clone of the SimComponent

}



Extended by: net.simplace.sim.control.exchange.DefaultExchangeComponent



Returned by: clone(), net.simplace.sim.control.exchange.DefaultExchangeComponent.clone(), createExchangeComponent(), createExchangeComponent(), createExchangeComponent()