mil.navy.nps.dis
Class StopFreezePdu

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

All Implemented Interfaces:

java.lang.Cloneable, SerializationInterface

public class StopFreezePdu

extends SimulationManagementFamily

Simulation management PDU to stop or freeze 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/StopFreezePdu.java

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

Hierarchy Diagram:

Summary:

The stopping of freezing of an entity/exercise shall be communicated using a Stop/Freeze 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(), changed sizeof to "relative size"

References:

DIS Data Dictionary : Stop/Freeze 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.4

See Also:

ProtocolDataUnit, PduElement, SerializationInterface

Field Summary

protected static StopFreezePdu	exemplar An "exemplar" object, which is filled out to the state that is needed most of the time.
protected UnsignedByte	frozenBehavior Frozen Behavior - This field shall specify the internal behavior of the simulation and its appearance while frozen to the other participants of the exercise.
protected UnsignedShort	padding A 16 bit Padding Field.
protected ClockTime	realWorldTime Real-World Time - This field shall specify the real-world time (UTC) at which the entity is to stop/freeze in the exercise.
protected UnsignedByte	reason Reason - This field shall specify the reason that an entity or exercise was stopped/frozen.
protected UnsignedInt	requestID Request ID - This field shall identify the specific and unique stop/freeze request being made by the simulation manager.
static int	sizeOf Constant value--size of a Stop/Freeze PDU including header.

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

StopFreezePdu()
Default constructor.

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.
StopFreezePdu	getExemplar()
UnsignedByte	getFrozenBehavior()
ClockTime	getRealWorldTime()
UnsignedByte	getReason()
UnsignedInt	getRequestID()
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(StopFreezePdu newExemplar)
void	setFrozenBehavior(int pFrozenBehavior)
void	setFrozenBehavior(UnsignedByte pFrozenBehavior)
void	setRealWorldTime(ClockTime pRealWorldTime)
void	setRealWorldTime(long pHour, long pTimePastHour)
void	setReason(int pReason)
void	setReason(UnsignedByte pReason)
void	setRequestID(int pRequestID)
void	setRequestID(UnsignedInt pRequestID)

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 stop/freeze in the exercise.

reason

protected UnsignedByte reason

Reason - This field shall specify the reason that an entity or exercise was stopped/frozen.

Value:

Enumeration. See references below for value.

References:

see Section 7 in EBV-DOC

DIS Data Dictionary: Reason Field

frozenBehavior

protected UnsignedByte frozenBehavior

Frozen Behavior - This field shall specify the internal behavior of the simulation and its appearance while frozen to the other participants of the exercise.

Value:

Enumeration. See references below for value.

References:

see Section 7 in EBV-DOC

DIS Data Dictionary: Frozen Behavior Field

padding

protected UnsignedShort padding

A 16 bit Padding Field. It is unused.

References:

DIS Data Dictionary: Padding - 16bit Field

requestID

protected UnsignedInt requestID

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

References:

DIS Data Dictionary: Request ID Field

sizeOf

public static final int sizeOf

Constant value--size of a Stop/Freeze PDU including header. sizeOf = 40 bytes

See Also:

Constant Field Values

exemplar

protected static StopFreezePdu 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

StopFreezePdu

public StopFreezePdu()

Default constructor. Initializes everything to zero, basically.

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 StopFreezePdu getExemplar()

setExemplar

public void setExemplar(StopFreezePdu newExemplar)

getRealWorldTime

public ClockTime getRealWorldTime()

setRealWorldTime

public void setRealWorldTime(ClockTime pRealWorldTime)

setRealWorldTime

public void setRealWorldTime(long pHour,
                             long pTimePastHour)

getReason

public UnsignedByte getReason()

setReason

public void setReason(UnsignedByte pReason)

setReason

public void setReason(int pReason)

getFrozenBehavior

public UnsignedByte getFrozenBehavior()

setFrozenBehavior

public void setFrozenBehavior(UnsignedByte pFrozenBehavior)

setFrozenBehavior

public void setFrozenBehavior(int pFrozenBehavior)

getRequestID

public UnsignedInt getRequestID()

setRequestID

public void setRequestID(UnsignedInt pRequestID)

setRequestID

public void setRequestID(int pRequestID)