mil.navy.nps.dis
Class StartResumePdu

java.lang.Object
  mil.navy.nps.dis.PduElement
      mil.navy.nps.dis.ProtocolDataUnit
          mil.navy.nps.dis.SimulationManagementFamily
              mil.navy.nps.dis.StartResumePdu

All Implemented Interfaces:

java.lang.Cloneable, SerializationInterface

public class StartResumePdu

extends SimulationManagementFamily

Simulation management PDU to start or resume an exercise.

Version:

1.0

Author:

Antonio Alexandre Rua (http://www.garfield.fe.up.pt/~alexrua)

Location:

Web: http://www.web3d.org/WorkingGroups/vrtp/mil/navy/nps/dis/StartResumePdu.java

or locally: ~/mil/navy/nps/dis/StartResumePdu.java

Hierarchy Diagram:

Summary:

The Start/Resume of an exercise shall be communicated using a Start/Resume PDU.

History:

16Sep97 /Antonio Alexandre Rua /New

8Dec97 /Ronan Fauglas /changes for documentation templates + complements in documentation

11Dec97 /Ronan Fauglas /changed access methods: thisVariable() --> getThisVariable()

References:

DIS Data Dictionary : Start/Resume PDU

DIS-Java-VRML Working Group: http://www.web3d.org/WorkingGroups/vrtp/dis-java-vrml/

DIS specification : IEEE 1278.1, Section 4.4.5.4, 5.4.6.3

See Also:

ProtocolDataUnit, PduElement, SerializationInterface

Field Summary

protected static StartResumePdu	exemplar An "exemplar" object, which is filled out to the state that is needed most of the time.
protected ClockTime	realWorldTime Real-World Time - This field shall specify the real-world time (UTC) at which the entity is to start/resume in the exercies.
protected UnsignedInt	requestID Request ID - This field shall identify the specific and unique start/resume request being made by the simulation manager.
protected ClockTime	simulationTime Simulation Time - This field shall specify the simulation time (time of day in the simulated world in UTC) at which the entity will start/resume in the exercise.
static int	sizeOf Constant value--total size of an Action Request PDU including header sizeOf = 44 bytes

Fields inherited from class mil.navy.nps.dis.SimulationManagementFamily

originatingEntityID, receivingEntityID

Fields inherited from class mil.navy.nps.dis.ProtocolDataUnit

DEBUG, exerciseID, pduType, protocolFamily, protocolVersion, timeReceived, timestamp

Constructor Summary

StartResumePdu()
Default constructor--fills with zeros for all values.

Method Summary

java.lang.Object	clone() Makes deep copies of all the instance variables, so we don't have two objects pointing to the same data.
void	deSerialize(java.io.DataInputStream inputStream) Deserialize our data from the input stream.
StartResumePdu	getExemplar()
ClockTime	getRealWorldTime()
UnsignedInt	getRequestID()
ClockTime	getSimulationTime()
int	length() Returns the length of the PDU header.
java.lang.String	pduName() Returns the name of this PDU
void	printValues(int indentLevel, java.io.PrintStream printStream) Prints the generated serialized object for debugging.
void	serialize(java.io.DataOutputStream outputStream) Serialize our data out to the stream.
void	setExemplar(StartResumePdu newExemplar)
void	setRealWorldTime(ClockTime pRealWorldTime)
void	setRequestID(long pRequestID)
void	setRequestID(UnsignedInt pRequestID)
void	setSimulationTime(ClockTime pSimulationTime)

Methods inherited from class mil.navy.nps.dis.SimulationManagementFamily

getOriginatingEntityID, getReceivingEntityID, setOriginatingEntityID, setReceivingEntityID

Methods inherited from class mil.navy.nps.dis.ProtocolDataUnit

byteArrayToPdu, datagramToPdu, debug, getExerciseID, getPaddingOfLength, getPduType, getProtocolFamily, getProtocolVersion, getRtpHeaderEnabled, getTimeReceived, getTimestamp, getVRMLTimestamp, makeTimestampCurrent, setExerciseID, setExerciseID, setPduType, setPduType, setProtocolFamily, setProtocolFamily, setProtocolVersion, setProtocolVersion, setRtpHeaderEnabled, setSimulationStartTime, setTimeReceived, setTimestamp, setTimestamp, stampTimeReceived, toString, trace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

realWorldTime

protected ClockTime realWorldTime

Real-World Time - This field shall specify the real-world time (UTC) at which the entity is to start/resume in the exercies. This information shall be used by the participating simulation applications to start/resume an exercise synchronously.

simulationTime

protected ClockTime simulationTime

Simulation Time - This field shall specify the simulation time (time of day in the simulated world in UTC) at which the entity will start/resume in the exercise.

requestID

protected UnsignedInt requestID

Request ID - This field shall identify the specific and unique start/resume request being made by the simulation manager.

Value:

A 32-bit monotonically increasing integer identifier inserted by the Simulation Manager into all Simulation Manager PDUs.

References:

References:

DIS Data Dictionary: Request ID Field

sizeOf

public static final int sizeOf

Constant value--total size of an Action Request PDU including header sizeOf = 44 bytes

See Also:

Constant Field Values

exemplar

protected static StartResumePdu exemplar

An "exemplar" object, which is filled out to the state that is needed most of the time.

Explanation

A brand new object has to have most of its values set, such as the forceID, protocol version, and so on. This lets the user fill out most of the values, save it in the class, then retrieve a copy of it as needed.

Constructor Detail

StartResumePdu

public StartResumePdu()

Default constructor--fills with zeros for all values.

Method Detail

serialize

public void serialize(java.io.DataOutputStream outputStream)

Description copied from class: PduElement

Serialize our data out to the stream. Subclasses of us should call super.Serialize() to make sure the superclasse's data is serialized out. The order in which instance variables are serialized is significant. They must be serialized in the same order they appear in the DIS spec. Prints out some information during execution if debugging flag is set.

Specified by:

serialize in interface SerializationInterface

Overrides:

serialize in class SimulationManagementFamily

deSerialize

public void deSerialize(java.io.DataInputStream inputStream)

Description copied from class: PduElement

Deserialize our data from the input stream. Subclasses of us should call super.deSerialize to make sure the superclass's data are properly affected. The order in which instance variables are serialized is significant. They must be deSerialized in the same order as they have been serialized as specified by the DIS spec.

Specified by:

deSerialize in interface SerializationInterface

Overrides:

deSerialize in class SimulationManagementFamily

clone

public java.lang.Object clone()

Description copied from class: PduElement

Makes deep copies of all the instance variables, so we don't have two objects pointing to the same data. The accessor methods make copies of the objects, rather than returning the objects themselves. The runtime provides the right object type with the call to super.clone(), and we cast it to our type. Subclasses should do the same thing, and all these ivars will be taken care of automatically.

Overrides:

clone in class SimulationManagementFamily

length

public int length()

Description copied from class: ProtocolDataUnit

Returns the length of the PDU header.

Overrides:

length in class SimulationManagementFamily

pduName

public java.lang.String pduName()

Description copied from class: SimulationManagementFamily

Returns the name of this PDU

Specified by:

pduName in class SimulationManagementFamily

Returns:

the name of this PDU

printValues

public void printValues(int indentLevel,
                        java.io.PrintStream printStream)

Description copied from class: PduElement

Prints the generated serialized object for debugging.

Overrides:

printValues in class SimulationManagementFamily

getExemplar

public StartResumePdu getExemplar()

setExemplar

public void setExemplar(StartResumePdu newExemplar)

getRealWorldTime

public ClockTime getRealWorldTime()

setRealWorldTime

public void setRealWorldTime(ClockTime pRealWorldTime)

getSimulationTime

public ClockTime getSimulationTime()

setSimulationTime

public void setSimulationTime(ClockTime pSimulationTime)

getRequestID

public UnsignedInt getRequestID()

setRequestID

public void setRequestID(UnsignedInt pRequestID)

setRequestID

public void setRequestID(long pRequestID)