Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS | NEXT CLASS FRAMES  | NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

Class mil.navy.nps.dis.StartResumePdu

java.lang.Object
  |
  +--mil.navy.nps.dis.PduElement
        |
        +--mil.navy.nps.dis.ProtocolDataUnit
              |
              +--mil.navy.nps.dis.SimulationManagementPdu
                    |
                    +--mil.navy.nps.dis.StartResumePdu

public class StartResumePdu
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/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.stl.nps.navy.mil/dis-java-vrml/
DIS specification : IEEE 1278.1, Section 4.4.5.4, 5.4.6.3
See Also:
ProtocolDataUnit, PduElement, mil.navy.nps.util.SerializationInterface

Field Summary
static StartResumePdu exemplar
          An "exemplar" object, which is filled out to the state that is needed most of the time.
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.
mil.navy.nps.util.UnsignedInt requestID
          Request ID - This field shall identify the specific and unique start/resume request being made by the simulation manager.
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.SimulationManagementPdu
originatingEntityID, receivingEntityID, sizeOf
 
Fields inherited from class mil.navy.nps.dis.ProtocolDataUnit
DEBUG, exerciseID, pduType, protocolFamily, protocolVersion, sizeOf, timestamp
 
Constructor Summary
StartResumePdu()
          Default constructor--fills with zeros for all values.
 
Method Summary
java.lang.Object clone()
           
void deSerialize(java.io.DataInputStream inputStream)
           
StartResumePdu getExemplar()
           
ClockTime getRealWorldTime()
           
mil.navy.nps.util.UnsignedInt getRequestID()
           
ClockTime getSimulationTime()
           
int length()
           
java.lang.String PDUName()
           
void printValues(int indentLevel, java.io.PrintStream printStream)
           
void serialize(java.io.DataOutputStream outputStream)
           
void setExemplar(StartResumePdu newExemplar)
           
void setRealWorldTime(ClockTime pRealWorldTime)
           
void setRequestID(mil.navy.nps.util.UnsignedInt pRequestID)
           
void setRequestID(long pRequestID)
           
void setSimulationTime(ClockTime pSimulationTime)
           
 
Methods inherited from class mil.navy.nps.dis.SimulationManagementPdu
clone, deSerialize, getOriginatingEntityID, getReceivingEntityID, length, PDUName, printValues, serialize, setOriginatingEntityID, setReceivingEntityID
 
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 mil.navy.nps.dis.PduElement
clone, deSerialize, length, printValues, serialize
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, 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 mil.navy.nps.util.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

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)
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 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 mil.navy.nps.util.UnsignedInt getRequestID()

setRequestID

public void setRequestID(mil.navy.nps.util.UnsignedInt pRequestID)

setRequestID

public void setRequestID(long pRequestID)

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS | NEXT CLASS FRAMES  | NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD