jsim.jmessage
Class Store

java.lang.Object
  extended by jsim.jmessage.Message
      extended by jsim.jmessage.Store
All Implemented Interfaces:
java.io.Serializable

public class Store
extends Message

The Store class represents all the data that need to be store in the database. It contains a scenario ID, the agent data, and the model input and output data. A Store object is sent from a model agent to the DBAgent after the model agent has received a report from the model bean it controls.

See Also:
Serialized Form

Field Summary
 Simulate agentData
          The model agent control data
 ModelData modelData
          The model input and output data
 java.lang.Integer scenarioID
          The ID of the scenario that the federate participates in
 
Fields inherited from class jsim.jmessage.Message
actionType
 
Constructor Summary
Store(java.lang.String actionType, java.lang.Integer scenarioID, Simulate agentData, ModelProperties modelProperties, FinalReport report)
          Constructs a Store instance.
 
Method Summary
 Simulate getAgentData()
          Returns the control data from the model agent.
 ModelData getModelData()
          Returns the model input and output data.
 java.lang.Integer getScenarioID()
          Returns the scenario ID.
 void readObject(java.io.ObjectInputStream in)
          Meets the Java serialization requirements.
 java.lang.String toString()
          Returns an XML fragemnt representing this instance of Store
 void writeObject(java.io.ObjectOutputStream out)
          Meets the Java serialization requirements.
 
Methods inherited from class jsim.jmessage.Message
getActionType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

scenarioID

public java.lang.Integer scenarioID
The ID of the scenario that the federate participates in


agentData

public Simulate agentData
The model agent control data


modelData

public ModelData modelData
The model input and output data

Constructor Detail

Store

public Store(java.lang.String actionType,
             java.lang.Integer scenarioID,
             Simulate agentData,
             ModelProperties modelProperties,
             FinalReport report)
Constructs a Store instance.

Parameters:
actionType - The action type
scenarioID - The scenario ID
agentData - The simulation control data from the model agent
modelProperties - The input model properties
report - The simulation result report from the model bean
Method Detail

getScenarioID

public java.lang.Integer getScenarioID()
Returns the scenario ID.

Returns:
Integer The scenario ID

getAgentData

public Simulate getAgentData()
Returns the control data from the model agent.

Returns:
Simulate The simulation control data

getModelData

public ModelData getModelData()
Returns the model input and output data.

Returns:
ModelData The model input and output data

toString

public java.lang.String toString()
Returns an XML fragemnt representing this instance of Store

Overrides:
toString in class java.lang.Object
Returns:
String The XML fragment

writeObject

public void writeObject(java.io.ObjectOutputStream out)
                 throws java.io.IOException
Meets the Java serialization requirements.

Parameters:
out - The ObjectOutputStream
Throws:
java.io.IOException

readObject

public void readObject(java.io.ObjectInputStream in)
                throws java.io.IOException,
                       java.lang.ClassNotFoundException
Meets the Java serialization requirements.

Parameters:
in - The ObjectInputStream
Throws:
java.io.Exception
java.io.IOException
java.lang.ClassNotFoundException