jsim.jmessage
Class Simulate

java.lang.Object
  jsim.jmessage.Message
      jsim.jmessage.Simulate

All Implemented Interfaces:

java.io.Serializable

public class Simulate
extends Message

This class contains the control data, which will be passed from a model agent to a model bean to control the execution of a simulation and improve the quality of simulation result. The control data, together with the model input and output, may also be stored in the database later on.

See Also:

Serialized Form

Field Summary

java.lang.String	agentName Name of the agent that generates the control data
java.lang.Integer	batchSize Batch size.
java.lang.Double	confidenceLevel Confidence level.
java.lang.Integer	numOfBatches Number of batches.
java.lang.Integer	numOfReplications Number of replications.
java.lang.Double	relativePrecision Relative precision.
java.lang.Integer	replicationSize Replication size.
java.lang.Double	transientPeriod Transient period.

Fields inherited from class jsim.jmessage.Message

actionType

Constructor Summary

Simulate(java.lang.String actionType, java.lang.String agentName, java.lang.Integer replicationSize, java.lang.Integer numOfReplications, java.lang.Double transientPeriod)
Constructs Simulate generated by the ReplicationAgent.

Simulate(java.lang.String actionType, java.lang.String agentName, java.lang.Integer batchSize, java.lang.Integer numOfBatches, java.lang.Double relativePrecision, java.lang.Double confidenceLevel)
Constructs Simulate generated by the BatchMeansAgent.

Method Summary

java.lang.String	getAgentName() Returns the name of the agent.
java.lang.Integer	getBatchSize() Returns the batch size.
java.lang.Double	getConfidenceLevel() Returns the confidence level.
java.lang.Integer	getNumOfBatches() Returns the number of batches.
java.lang.Integer	getNumOfReplications() Returns the number of replications.
java.lang.Double	getRelativePrecision() Returns the relative precision.
java.lang.Integer	getReplicationSize() Returns the replication size.
java.lang.Double	getTransientPeriod() Returns the transient period.
java.lang.String	toString() Converts this class into an XML fragment.

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

agentName

public java.lang.String agentName

Name of the agent that generates the control data

batchSize

public java.lang.Integer batchSize

Batch size.

numOfBatches

public java.lang.Integer numOfBatches

Number of batches.

relativePrecision

public java.lang.Double relativePrecision

Relative precision.

confidenceLevel

public java.lang.Double confidenceLevel

Confidence level.

replicationSize

public java.lang.Integer replicationSize

Replication size.

numOfReplications

public java.lang.Integer numOfReplications

Number of replications.

transientPeriod

public java.lang.Double transientPeriod

Transient period.

Constructor Detail

Simulate

public Simulate(java.lang.String actionType,
                java.lang.String agentName,
                java.lang.Integer batchSize,
                java.lang.Integer numOfBatches,
                java.lang.Double relativePrecision,
                java.lang.Double confidenceLevel)

Constructs Simulate generated by the BatchMeansAgent.

Parameters:

actionType - The action type

agentName - The name of the agent

batchSize - The batch size

numOfBatches - The number of batches

relativePrecision - The relative precision

confidenceLevel - The confidence level

Simulate

public Simulate(java.lang.String actionType,
                java.lang.String agentName,
                java.lang.Integer replicationSize,
                java.lang.Integer numOfReplications,
                java.lang.Double transientPeriod)

Constructs Simulate generated by the ReplicationAgent.

Parameters:

actionType - The action type

agentName - Name of the agent

replicationSize - Replication size

numOfReplications - Number of replications

transientPeriod - Transient period

Method Detail

getAgentName

public java.lang.String getAgentName()

Returns the name of the agent.

Returns:

String Agent name

getBatchSize

public java.lang.Integer getBatchSize()

Returns the batch size.

Returns:

Integer The batch size.

getNumOfBatches

public java.lang.Integer getNumOfBatches()

Returns the number of batches.

Returns:

Integer The number of batches.

getRelativePrecision

public java.lang.Double getRelativePrecision()

Returns the relative precision.

Parameters:

Double - The relative precision.

getConfidenceLevel

public java.lang.Double getConfidenceLevel()

Returns the confidence level.

Returns:

Double The confidence level.

getReplicationSize

public java.lang.Integer getReplicationSize()

Returns the replication size.

Returns:

Integer The replication size.

getNumOfReplications

public java.lang.Integer getNumOfReplications()

Returns the number of replications.

Parameters:

Integer - The number of replications.

getTransientPeriod

public java.lang.Double getTransientPeriod()

Returns the transient period.

Returns:

Double The transient period.

toString

public java.lang.String toString()

Converts this class into an XML fragment. This method is invoked by the Result class to transform a query result containing this and other Java objects into an XML document.

Overrides:

toString in class java.lang.Object