Class ActionRequestPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.SimulationManagementFamilyPdu

edu.nps.moves.dis7.pdus.ActionRequestPdu

All Implemented Interfaces:

Marshaller, Serializable

public class ActionRequestPdu
extends SimulationManagementFamilyPdu
implements Serializable

7.5.7 A request from a Simulation Manager (SM) to a managed entity to perform a specified action. See 5.6.5.7

See Also:

• IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation - Application Protocols
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ActionRequestActionID	actionID	identifies the particular action being requested(see Section 7 of SISO-REF-010). uid 71
protected ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected List<FixedDatum>	fixedDatums	variable length list of fixed datums
static final String	NAME	The name of this PDU type
protected int	numberOfFixedDatumRecords	Number of fixed datum records
protected int	numberOfVariableDatumRecords	Number of variable datum records, handled automatically by marshaller at run time (and not modifiable by end-user programmers)
protected int	requestID	identifies the request being made by the simulation manager
protected List<VariableDatum>	variableDatums	variable length list of variable length datums

Fields inherited from class edu.nps.moves.dis7.pdus.SimulationManagementFamilyPdu

FAMILY_NAME, originatingID, receivingID

Fields inherited from class edu.nps.moves.dis7.pdus.PduBase

padding, pduStatus

Fields inherited from class edu.nps.moves.dis7.pdus.Pdu

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

Constructor	Description
ActionRequestPdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
ActionRequestPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
ActionRequestPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
ActionRequestPdu	copyDataOutputStream()	copy method creates a deep copy of current object using DataOutputStream methods.
boolean	equals(Object obj)
boolean	equalsImpl(Object obj)	Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
ActionRequestActionID	getActionID()	Getter for actionID
List<FixedDatum>	getFixedDatums()	Getter for fixedDatums
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
int	getRequestID()	Getter for requestID
List<VariableDatum>	getVariableDatums()	Getter for variableDatums
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
ActionRequestPdu	setActionID(ActionRequestActionID pActionID)	Setter for actionID
ActionRequestPdu	setFixedDatums(List<FixedDatum> pFixedDatums)	Setter for fixedDatums
ActionRequestPdu	setRequestID(int pRequestID)	Setter for requestID
ActionRequestPdu	setVariableDatums(List<VariableDatum> pVariableDatums)	Setter for variableDatums
String	toString()
int	unmarshal(DataInputStream dis)	Deserializes an object from a DataInputStream.
int	unmarshal(ByteBuffer byteBuffer)	Unpacks a Pdu from the underlying data.

Methods inherited from class edu.nps.moves.dis7.pdus.SimulationManagementFamilyPdu

getOriginatingID, getReceivingID, setOriginatingID, setReceivingID

Methods inherited from class edu.nps.moves.dis7.pdus.PduBase

getPadding, getPduStatus, setPadding, setPadding, setPduStatus

Methods inherited from class edu.nps.moves.dis7.pdus.Pdu

copyByPduFactory, getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, getTimestampSeconds, isAcknowledgeRPdu, isActionRequestPdu, isActionRequestRPdu, isActionResponsePdu, isActionResponseRPdu, isAggregateStatePdu, isAppearancePdu, isArealObjectStatePdu, isArticulatedPartsPdu, isAttributePdu, isCollisionElasticPdu, isCollisionPdu, isCommentPdu, isCommentRPdu, isCreateEntityPdu, isCreateEntityRPdu, isDataPdu, isDataQueryPdu, isDataQueryRPdu, isDataRPdu, isDesignatorPdu, isDetonationPdu, isDirectedEnergyFirePdu, isDistributedEmissionsRegenerationFamilyPdu, isElectromagneticEmissionPdu, isEntityDamageStatusPdu, isEntityInformationInteractionFamilyPdu, isEntityManagementFamilyPdu, isEntityStatePdu, isEntityStateUpdatePdu, isEnvironmentalProcessPdu, isEventReportPdu, isEventReportRPdu, isFirePdu, isGriddedDataPdu, isIFFPdu, isInformationOperationsActionPdu, isInformationOperationsFamilyPdu, isInformationOperationsReportPdu, isIntercomControlPdu, isIntercomSignalPdu, isIsGroupOfPdu, isIsPartOfPdu, isLEDetonationPdu, isLEFirePdu, isLinearObjectStatePdu, isLiveEntityDetonationPdu, isLiveEntityFirePdu, isLogisticsFamilyPdu, isMinefieldDataPdu, isMinefieldFamilyPdu, isMinefieldQueryPdu, isMinefieldResponseNACKPdu, isMinefieldStatePdu, isPointObjectStatePdu, isRadioCommunicationsFamilyPdu, isReceiverPdu, isRecordQueryRPdu, isRecordRPdu, isReliablePdu, isRemoveEntityPdu, isRemoveEntityRPdu, isRepairCompletePdu, isRepairResponsePdu, isResupplyCancelPdu, isResupplyOfferPdu, isResupplyReceivedPdu, isSEESPdu, isSetDataPdu, isSetDataRPdu, isSetRecordRPdu, isSignalPdu, isSimulationManagementFamilyPdu, isSimulationManagementWithReliabilityFamilyPdu, isStartResumePdu, isStartResumeRPdu, isStopFreezePdu, isStopFreezeRPdu, isSupplementalEmissionEntityStatePdu, isSyntheticEnvironmentFamilyPdu, isTransferOwnershipPdu, isTransmitterPdu, isTSPIPdu, isUnderwaterAcousticPdu, isWarfareFamilyPdu, marshal, occursAfter, occursBefore, occursSameTime, setExerciseID, setExerciseID, setLength, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp, setTimestampSeconds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NAME

public static final String NAME

The name of this PDU type

See Also:

• Constant Field Values

requestID

protected int requestID

identifies the request being made by the simulation manager

actionID

protected ActionRequestActionID actionID

identifies the particular action being requested(see Section 7 of SISO-REF-010). uid 71

numberOfFixedDatumRecords

protected int numberOfFixedDatumRecords

Number of fixed datum records

numberOfVariableDatumRecords

protected int numberOfVariableDatumRecords

Number of variable datum records, handled automatically by marshaller at run time (and not modifiable by end-user programmers)

fixedDatums

protected List<FixedDatum> fixedDatums

variable length list of fixed datums

variableDatums

protected List<VariableDatum> variableDatums

variable length list of variable length datums

byteArrayOutputStream

protected ByteArrayOutputStream byteArrayOutputStream

byteArrayOutputStream (baos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

dataOutputStream

protected DataOutputStream dataOutputStream

dataOutputStream (dos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

Constructor Details

ActionRequestPdu

public ActionRequestPdu()

Constructor creates and configures a new instance object

Method Details

copy

public ActionRequestPdu copy()

copy method creates a deep copy of current object using preferred marshalling method

Returns:

deep copy of PDU

copyByteBuffer

public ActionRequestPdu copyByteBuffer()

Creates a "deep copy" of current object using ByteBuffer methods.

Returns:

deep copy of PDU

copyDataOutputStream

public ActionRequestPdu copyDataOutputStream()

copy method creates a deep copy of current object using DataOutputStream methods.

Returns:

deep copy of PDU

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Specified by:

getMarshalledSize in interface Marshaller

Overrides:

getMarshalledSize in class SimulationManagementFamilyPdu

Returns:

serialized size in bytes

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

setRequestID

public ActionRequestPdu setRequestID(int pRequestID)

Setter for requestID

Parameters:

pRequestID - new value of interest

Returns:

same object to permit progressive setters

getRequestID

public int getRequestID()

Getter for requestID

Returns:

value of interest

setActionID

public ActionRequestPdu setActionID(ActionRequestActionID pActionID)

Setter for actionID

Parameters:

pActionID - new value of interest

Returns:

same object to permit progressive setters

getActionID

public ActionRequestActionID getActionID()

Getter for actionID

Returns:

value of interest

setFixedDatums

public ActionRequestPdu setFixedDatums(List<FixedDatum> pFixedDatums)

Setter for fixedDatums

Parameters:

pFixedDatums - new value of interest

Returns:

same object to permit progressive setters

getFixedDatums

public List<FixedDatum> getFixedDatums()

Getter for fixedDatums

Returns:

value of interest

setVariableDatums

public ActionRequestPdu setVariableDatums(List<VariableDatum> pVariableDatums)

Setter for variableDatums

Parameters:

pVariableDatums - new value of interest

Returns:

same object to permit progressive setters

getVariableDatums

public List<VariableDatum> getVariableDatums()

Getter for variableDatums

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class SimulationManagementFamilyPdu

Parameters:

dos - the OutputStream

Throws:

Exception - if something goes wrong

See Also:

• DataOutputStream

unmarshal

public int unmarshal(DataInputStream dis)
              throws Exception

Deserializes an object from a DataInputStream.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class SimulationManagementFamilyPdu

Parameters:

dis - the InputStream

Returns:

marshalled serialized size in bytes

Throws:

Exception - if something goes wrong

See Also:

• DataInputStream
• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

marshal

public void marshal(ByteBuffer byteBuffer)
             throws Exception

Packs an object into the ByteBuffer.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class SimulationManagementFamilyPdu

Parameters:

byteBuffer - The ByteBuffer at the position to begin writing

Throws:

BufferOverflowException - if byteBuffer is too small

ReadOnlyBufferException - if byteBuffer is read only

Exception - ByteBuffer-generated exception

See Also:

• ByteBuffer

unmarshal

public int unmarshal(ByteBuffer byteBuffer)
              throws Exception

Unpacks a Pdu from the underlying data.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class SimulationManagementFamilyPdu

Parameters:

byteBuffer - The ByteBuffer at the position to begin reading

Returns:

marshalled serialized size in bytes

Throws:

BufferUnderflowException - if byteBuffer is too small

Exception - ByteBuffer-generated exception

See Also:

• ByteBuffer
• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

equals

public boolean equals(Object obj)

Overrides:

equals in class SimulationManagementFamilyPdu

equalsImpl

public boolean equalsImpl(Object obj)

Description copied from class: Pdu

Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object

Overrides:

equalsImpl in class SimulationManagementFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class SimulationManagementFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class SimulationManagementFamilyPdu