mil.navy.nps.dis
Class ActionRequestPdu

java.lang.Object
  mil.navy.nps.dis.PduElement
      mil.navy.nps.dis.ProtocolDataUnit
          mil.navy.nps.dis.SimulationManagementFamily
              mil.navy.nps.dis.ActionRequestPdu

All Implemented Interfaces:

java.lang.Cloneable, SerializationInterface

public class ActionRequestPdu

extends SimulationManagementFamily

Simulation management PDU to request an exercise action by a managed entity.

Version:

1.0

Author:

Antonio Alexandre Rua (http://www.garfield.fe.up.pt/~alexrua)

Location:

Web: http://www.web3d.org/WorkingGroups/vrtp/mil/navy/nps/dis/ActionRequestPdu.java

or locally: ~/mil/navy/nps/dis/ActionRequestPdu.java

Hierarchy Diagram:

Summary:

A request from a Simulation Manager (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.web3d.org/WorkingGroups/vrtp/dis-java-vrml/

DIS specification : IEEE 1278.1, Section 5.4.6.6, 4.4.5.4.6

See Also:

ProtocolDataUnit, PduElement, SerializationInterface, CreateEntityPdu, RemoveEntityPdu, StartResumePdu, StopFreezePdu, AcknowledgePdu, ActionRequestPdu, ActionResponsePdu, DataQueryPdu, SetDataPdu, DataPdu, EventReportPdu, CommentPdu

Field Summary

protected UnsignedInt	actionID Action ID - This field shall specify the particular action that is requested by the simulation manager.
protected DatumSpecification	datumInformation Datum Information - This field shall specify the types of datum and the value of the datum to be communicated.
protected static ActionRequestPdu	exemplar An "exemplar" object, which is filled out to the state that is needed most of the time.
protected 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.SimulationManagementFamily

originatingEntityID, receivingEntityID

Fields inherited from class mil.navy.nps.dis.ProtocolDataUnit

DEBUG, exerciseID, pduType, protocolFamily, protocolVersion, timeReceived, timestamp

Constructor Summary

ActionRequestPdu()
Default constructor--fills with zeros for all values.

Method Summary

java.lang.Object	clone() Makes deep copies of all the instance variables, so we don't have two objects pointing to the same data.
void	deSerialize(java.io.DataInputStream inputStream) Deserialize our data from the input stream.
UnsignedInt	getActionID()
DatumSpecification	getDatumInformation()
ActionRequestPdu	getExemplar()
UnsignedInt	getRequestID()
int	length() Returns the length of the PDU header.
java.lang.String	pduName() Returns the name of this PDU
void	printValues(int indentLevel, java.io.PrintStream printStream) Prints the generated serialized object for debugging.
void	serialize(java.io.DataOutputStream outputStream) Serialize our data out to the stream.
void	setActionID(long pActionID)
void	setDatumInformation(DatumSpecification pDatumSpecification)
void	setExemplar(ActionRequestPdu newExemplar)
void	setRequestID(long pRequestID)

Methods inherited from class mil.navy.nps.dis.SimulationManagementFamily

getOriginatingEntityID, getReceivingEntityID, setOriginatingEntityID, setReceivingEntityID

Methods inherited from class mil.navy.nps.dis.ProtocolDataUnit

byteArrayToPdu, datagramToPdu, debug, getExerciseID, getPaddingOfLength, getPduType, getProtocolFamily, getProtocolVersion, getRtpHeaderEnabled, getTimeReceived, getTimestamp, getVRMLTimestamp, makeTimestampCurrent, setExerciseID, setExerciseID, setPduType, setPduType, setProtocolFamily, setProtocolFamily, setProtocolVersion, setProtocolVersion, setRtpHeaderEnabled, setSimulationStartTime, setTimeReceived, setTimestamp, setTimestamp, stampTimeReceived, toString, trace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

requestID

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

See Also:

Constant Field Values

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()

Description copied from class: SimulationManagementFamily

Returns the name of this PDU

Specified by:

pduName in class SimulationManagementFamily

Returns:

the name of this PDU

serialize

public void serialize(java.io.DataOutputStream outputStream)

Description copied from class: PduElement

Serialize our data out to the stream. Subclasses of us should call super.Serialize() to make sure the superclasse's data is serialized out. The order in which instance variables are serialized is significant. They must be serialized in the same order they appear in the DIS spec. Prints out some information during execution if debugging flag is set.

Specified by:

serialize in interface SerializationInterface

Overrides:

serialize in class SimulationManagementFamily

deSerialize

public void deSerialize(java.io.DataInputStream inputStream)

Description copied from class: PduElement

Deserialize our data from the input stream. Subclasses of us should call super.deSerialize to make sure the superclass's data are properly affected. The order in which instance variables are serialized is significant. They must be deSerialized in the same order as they have been serialized as specified by the DIS spec.

Specified by:

deSerialize in interface SerializationInterface

Overrides:

deSerialize in class SimulationManagementFamily

clone

public java.lang.Object clone()

Description copied from class: PduElement

Makes deep copies of all the instance variables, so we don't have two objects pointing to the same data. The accessor methods make copies of the objects, rather than returning the objects themselves. The runtime provides the right object type with the call to super.clone(), and we cast it to our type. Subclasses should do the same thing, and all these ivars will be taken care of automatically.

Overrides:

clone in class SimulationManagementFamily

length

public int length()

Description copied from class: ProtocolDataUnit

Returns the length of the PDU header.

Overrides:

length in class SimulationManagementFamily

printValues

public void printValues(int indentLevel,
                        java.io.PrintStream printStream)

Description copied from class: PduElement

Prints the generated serialized object for debugging.

Overrides:

printValues in class SimulationManagementFamily

getExemplar

public ActionRequestPdu getExemplar()

setExemplar

public void setExemplar(ActionRequestPdu newExemplar)

getRequestID

public UnsignedInt getRequestID()

setRequestID

public void setRequestID(long pRequestID)

getActionID

public UnsignedInt getActionID()

setActionID

public void setActionID(long pActionID)

getDatumInformation

public DatumSpecification getDatumInformation()

setDatumInformation

public void setDatumInformation(DatumSpecification pDatumSpecification)