Contents | Package | Class | Tree | Deprecated | Index | Help
PREV | NEXT SHOW LISTS | HIDE LISTS

Class mil.navy.nps.dis.ActionResponsePdu

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

public class ActionResponsePdu
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/ActionResponsePdu.java
Hierarchy Diagram:
Summary:
When an entity receives an Action Request PDU, that entity shall acknowledge the receipt of the Action Request PDU with an Action Response 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 : Action Response PDU
DIS-Java-VRML Working Group: http://www.stl.nps.navy.mil/dis-java-vrml/
DIS specification : IEEE 1278.1, Section 5.4.6.7
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 the value of the datum to be communicated.
static ActionResponsePdu  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 request made by the simulation manager.
mil.navy.nps.util.UnsignedInt  requestStatus
Request Status - This field shall identify the status of the requested action.
static int  sizeOf
Constant value--size of an Action Response PDU without headder nor DatumSpecification.
 
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
 ActionResponsePdu()
Default constructor--fills with zeros for all values.
 

Method Summary
java.lang.Object  clone()
 
void  deSerialize(java.io.DataInputStream inputStream)
 
DatumSpecification  getDatumInformation()
 
ActionResponsePdu  getExemplar()
 
mil.navy.nps.util.UnsignedInt  getRequestID()
 
mil.navy.nps.util.UnsignedInt  getRequestStatus()
 
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(ActionResponsePdu newExemplar)
 
void  setRequestID(long pRequestID)
 
void  setRequestStatus(long pRequestStatus)
 
 
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, notify, notifyAll, 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 request 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

requestStatus

protected mil.navy.nps.util.UnsignedInt requestStatus
Request Status - This field shall identify the status of the requested action.
Value:
Enumeration, see references below for values.
References:
DIS Data Dictionary: Request Status Field

datumInformation

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

sizeOf

public static final int sizeOf
Constant value--size of an Action Response PDU without headder nor DatumSpecification. Here:sizeOf = 8 bytes

exemplar

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

ActionResponsePdu

public ActionResponsePdu()
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 ActionResponsePdu getExemplar()

setExemplar

public void setExemplar(ActionResponsePdu newExemplar)

getRequestID

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

setRequestID

public void setRequestID(long pRequestID)

getRequestStatus

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

setRequestStatus

public void setRequestStatus(long pRequestStatus)

getDatumInformation

public DatumSpecification getDatumInformation()

setDatumInformation

public void setDatumInformation(DatumSpecification pDatumSpecification)

Contents | Package | Class | Tree | Deprecated | Index | Help
PREV | NEXT SHOW LISTS | HIDE LISTS