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.DataPdu

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

public class DataPdu
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/DataPdu.java
Hierarchy Diagram:
Summary:
Information issued in response to a Data Query PDU or Set Data PDU shall be communicated using a Data 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: Data PDU (remote Data PDU)
DIS-Java-VRML Working Group: http://www.stl.nps.navy.mil/dis-java-vrml/
DIS specification : IEEE 1278.1, Section 5.4.6.10, 4.4.5.4.10
See Also:
ProtocolDataUnit, PduElement, mil.navy.nps.util.SerializationInterface, CreateEntityPdu, RemoveEntityPdu, StartResumePdu, StopFreezePdu, AcknowledgePdu, ActionRequestPdu, ActionResponsePdu, DataQueryPdu, SetDataPdu, DataPdu, EventReportPdu, CommentPdu

Field Summary
DatumSpecification datumInformation
          Datum Information - This field shall specify the types of datum and their value to be communicated.
static DataPdu exemplar
          An "exemplar" object, which is filled out to the state that is needed most of the time.
mil.navy.nps.util.UnsignedInt requestID
          Request ID - This field shall identify the matching response to a Data Query PDU or Set Data PDU made by the simulation manager.
static int sizeOf
          Constant value--size of a Data PDU without headder(stands for RequestId and padding which is not represented).
 
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
DataPdu()
          Default constructor--fills with zeros for all values.
 
Method Summary
java.lang.Object clone()
           
void deSerialize(java.io.DataInputStream inputStream)
           
DatumSpecification getDatumInformation()
           
DataPdu getExemplar()
           
mil.navy.nps.util.UnsignedInt getRequestID()
           
int length()
           
java.lang.String PDUName()
           
void printValues(int indentLevel, java.io.PrintStream printStream)
           
void serialize(java.io.DataOutputStream outputStream)
           
void setDatumInformation(DatumSpecification pDatumSpecification)
           
void setExemplar(DataPdu newExemplar)
           
void setRequestID(long pRequestID)
           
 
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

requestID

protected mil.navy.nps.util.UnsignedInt requestID
Request ID - This field shall identify the matching response to a Data Query PDU or Set Data PDU made by the simulation manager.
Value:
A 32-bit monotonically increasing integer identifier inserted by the Simulation Manager into all Simulation Manager PDUs.
References:
DIS Data Dictionary: Request ID Field

datumInformation

protected DatumSpecification datumInformation
Datum Information - This field shall specify the types of datum and their value to be communicated.

sizeOf

public static final int sizeOf
Constant value--size of a Data PDU without headder(stands for RequestId and padding which is not represented). sizeOf = 8 bytes

exemplar

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

DataPdu

public DataPdu()
Default constructor--fills with zeros for all values.
Method Detail

PDUName

public java.lang.String PDUName()
Overrides:
PDUName in class SimulationManagementPdu

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

printValues

public void printValues(int indentLevel,
                        java.io.PrintStream printStream)
Overrides:
printValues in class SimulationManagementPdu

getExemplar

public DataPdu getExemplar()

setExemplar

public void setExemplar(DataPdu newExemplar)

getRequestID

public mil.navy.nps.util.UnsignedInt getRequestID()

setRequestID

public void setRequestID(long pRequestID)

getDatumInformation

public DatumSpecification getDatumInformation()

setDatumInformation

public void setDatumInformation(DatumSpecification pDatumSpecification)

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