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

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

public class ActionRequestPdu
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/ActionRequestPdu.java
Hierarchy Diagram:
Summary:
A request from an SM to a managed entity to perform a specified action shall be communicated using an Action Request PDU.
Note:
Here we have "flattened" what DIS refers to as the Simulation Address, having now two separate fields: Site and Application
History:
16Sep97 /Antonio Alexandre Rua /New
8Dec97 /Ronan Fauglas /changes for documentation templates + complements in documentation
11Dec97 /Ronan Fauglas /changed access methods: thisVariable() --> getThisVariable()
11Jan98 /Ronan Fauglas /changed DatumSpecification ---> DatumInformation
References:
DIS Data Dictionary : Action Request PDU
DIS-Java-VRML Working Group: http://www.stl.nps.navy.mil/dis-java-vrml/
DIS specification : IEEE 1278.1, Section 5.4.6.6, 4.4.5.4.6
See Also:
ProtocolDataUnit, PduElement, mil.navy.nps.util.SerializationInterface, CreateEntityPdu, RemoveEntityPdu, StartResumePdu, StopFreezePdu, AcknowledgePdu, ActionRequestPdu, ActionResponsePdu, DataQueryPdu, SetDataPdu, DataPdu, EventReportPdu, CommentPdu

Field Summary
mil.navy.nps.util.UnsignedInt actionID
          Action ID - This field shall specify the particular action that is requested by the simulation manager.
DatumSpecification datumInformation
          Datum Information - This field shall specify the types of datum and the value of the datum to be communicated.
static ActionRequestPdu 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 request being made by the simulation manager.
static int sizeOf
          Constant value--size of an Action Request PDU without headder nor Datumspecification Record.
 
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
ActionRequestPdu()
          Default constructor--fills with zeros for all values.
 
Method Summary
java.lang.Object clone()
           
void deSerialize(java.io.DataInputStream inputStream)
           
mil.navy.nps.util.UnsignedInt getActionID()
           
DatumSpecification getDatumInformation()
           
ActionRequestPdu 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 setActionID(long pActionID)
           
void setDatumInformation(DatumSpecification pDatumSpecification)
           
void setExemplar(ActionRequestPdu 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 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:
DIS Data Dictionary: Request ID Field

actionID

protected mil.navy.nps.util.UnsignedInt actionID
Action ID - This field shall specify the particular action that is requested by the simulation manager.
Value:
Enumeration, see references below for values.
References:
see Section 7 in EBV-DOC
DIS Data Dictionary: Action ID 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 Request PDU without headder nor Datumspecification Record. sizeOf = 8 bytes

exemplar

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

ActionRequestPdu

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

setExemplar

public void setExemplar(ActionRequestPdu newExemplar)

getRequestID

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

setRequestID

public void setRequestID(long pRequestID)

getActionID

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

setActionID

public void setActionID(long pActionID)

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