Class mil.navy.nps.dis.StopFreezePdu
java.lang.Object
|
+--mil.navy.nps.dis.PduElement
|
+--mil.navy.nps.dis.ProtocolDataUnit
|
+--mil.navy.nps.dis.SimulationManagementPdu
|
+--mil.navy.nps.dis.StopFreezePdu
- public class StopFreezePdu
- extends SimulationManagementPdu
- Version:
- 1.0
- Author:
- Antonio Alexandre Rua (http://www.garfield.fe.up.pt/~alexrua)
- Location:
-
http://www.stl.nps.navy.mil/dis-java-vrml/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.stl.nps.navy.mil/dis-java-vrml/
- DIS specification : IEEE 1278.1, Section 4.4.5.4, 5.4.6.4
- See Also:
- ProtocolDataUnit, PduElement, mil.navy.nps.util.SerializationInterface
Field Summary
|
static StopFreezePdu
|
exemplar
An "exemplar" object, which is filled out to the state that is needed most of the time.
|
mil.navy.nps.util.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.
|
mil.navy.nps.util.UnsignedShort
|
padding
A 16 bit Padding Field. |
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. |
mil.navy.nps.util.UnsignedByte
|
reason
Reason - This field shall specify the reason that an entity or exercise was stopped/frozen.
|
mil.navy.nps.util.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.
|
Methods inherited from class mil.navy.nps.dis.ProtocolDataUnit |
, clone, datagramToPdu, deSerialize, getExerciseID, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, getVRMLTimestamp, length, makeTimestampCurrent, PDUName, printValues, serialize, setExerciseID, setExerciseID, setPduType, setPduType, setProtocolFamily, setProtocolFamily, setProtocolVersion, setProtocolVersion, setSimulationStartTime, setTimestamp, setTimestamp |
Methods inherited from class java.lang.Object |
, clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait |
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 mil.navy.nps.util.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 mil.navy.nps.util.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 mil.navy.nps.util.UnsignedShort padding
- A 16 bit Padding Field. It is unused.
- References:
-
- DIS Data Dictionary:
Padding - 16bit Field
requestID
protected mil.navy.nps.util.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
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.
StopFreezePdu
public StopFreezePdu()
- Default constructor. Initializes everything to zero, basically.
serialize
public void serialize(java.io.DataOutputStream outputStream)
- Overrides:
- serialize in class SimulationManagementPdu
deSerialize
public void deSerialize(java.io.DataInputStream inputStream)
- Overrides:
- deSerialize in class SimulationManagementPdu
clone
public java.lang.Object clone()
- Overrides:
- clone in class SimulationManagementPdu
length
public int length()
- Overrides:
- length in class SimulationManagementPdu
PDUName
public java.lang.String PDUName()
- Overrides:
- PDUName in class SimulationManagementPdu
printValues
public void printValues(int indentLevel,
java.io.PrintStream printStream)
- Overrides:
- printValues in class SimulationManagementPdu
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 mil.navy.nps.util.UnsignedByte getReason()
setReason
public void setReason(mil.navy.nps.util.UnsignedByte pReason)
setReason
public void setReason(int pReason)
getFrozenBehavior
public mil.navy.nps.util.UnsignedByte getFrozenBehavior()
setFrozenBehavior
public void setFrozenBehavior(mil.navy.nps.util.UnsignedByte pFrozenBehavior)
setFrozenBehavior
public void setFrozenBehavior(int pFrozenBehavior)
getRequestID
public mil.navy.nps.util.UnsignedInt getRequestID()
setRequestID
public void setRequestID(mil.navy.nps.util.UnsignedInt pRequestID)
setRequestID
public void setRequestID(int pRequestID)