edu.nps.moves.dis7mobile
Class ActionRequestPdu

java.lang.Object
  edu.nps.moves.dis7mobile.PduSuperclass
      edu.nps.moves.dis7mobile.Pdu
          edu.nps.moves.dis7mobile.SimulationManagementFamilyPdu
              edu.nps.moves.dis7mobile.ActionRequestPdu

All Implemented Interfaces:

java.io.Serializable

public class ActionRequestPdu
extends SimulationManagementFamilyPdu
implements java.io.Serializable

Section 7.5.7. Request from simulation manager to a managed entity to perform a specified action. COMPLETE Copyright (c) 2008-2010, MOVES Institute, Naval Postgraduate School. All rights reserved. This work is licensed under the BSD open source license, available at https://www.movesinstitute.org/licenses/bsd.html

Author:

DMcG

See Also:

Serialized Form

Field Summary

protected long	actionID identifies the particular action being requested(see Section 7 of SISO-REF-010).
protected java.util.List<FixedDatum>	fixedDatums variable length list of fixed datums
protected long	numberOfFixedDatumRecords Number of fixed datum records
protected long	numberOfVariableDatumRecords Number of variable datum records
protected EntityID	originatingID Identifier for originating entity(or simulation)
protected EntityID	receivingID Identifier for the receiving entity(or simulation)
protected long	requestID identifies the request being made by the simulaton manager
protected java.util.List<VariableDatum>	variableDatums variable length list of variable length datums

Fields inherited from class edu.nps.moves.dis7mobile.SimulationManagementFamilyPdu

originatingEntityID, receivingEntityID

Fields inherited from class edu.nps.moves.dis7mobile.Pdu

padding, pduStatus

Fields inherited from class edu.nps.moves.dis7mobile.PduSuperclass

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

ActionRequestPdu()
Constructor

Method Summary

boolean	equals(java.lang.Object obj)
boolean	equalsImpl(java.lang.Object obj) Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
long	getActionID()
java.util.List<FixedDatum>	getFixedDatums()
int	getMarshalledSize()
long	getNumberOfFixedDatumRecords()
long	getNumberOfVariableDatumRecords()
EntityID	getOriginatingID()
EntityID	getReceivingID()
long	getRequestID()
java.util.List<VariableDatum>	getVariableDatums()
void	marshal(java.nio.ByteBuffer buff) Packs a Pdu into the ByteBuffer.
void	marshal(java.io.DataOutputStream dos)
void	setActionID(long pActionID)
void	setFixedDatums(java.util.List<FixedDatum> pFixedDatums)
void	setNumberOfFixedDatumRecords(long pNumberOfFixedDatumRecords) Note that setting this value will not change the marshalled value.
void	setNumberOfVariableDatumRecords(long pNumberOfVariableDatumRecords) Note that setting this value will not change the marshalled value.
void	setOriginatingID(EntityID pOriginatingID)
void	setReceivingID(EntityID pReceivingID)
void	setRequestID(long pRequestID)
void	setVariableDatums(java.util.List<VariableDatum> pVariableDatums)
void	unmarshal(java.nio.ByteBuffer buff) Unpacks a Pdu from the underlying data.
void	unmarshal(java.io.DataInputStream dis)

Methods inherited from class edu.nps.moves.dis7mobile.SimulationManagementFamilyPdu

getOriginatingEntityID, getReceivingEntityID, setOriginatingEntityID, setReceivingEntityID

Methods inherited from class edu.nps.moves.dis7mobile.Pdu

getPadding, getPduStatus, marshal, setPadding, setPduStatus

Methods inherited from class edu.nps.moves.dis7mobile.PduSuperclass

getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, setExerciseID, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

originatingID

protected EntityID originatingID

Identifier for originating entity(or simulation)

receivingID

protected EntityID receivingID

Identifier for the receiving entity(or simulation)

requestID

protected long requestID

identifies the request being made by the simulaton manager

actionID

protected long actionID

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

numberOfFixedDatumRecords

protected long numberOfFixedDatumRecords

Number of fixed datum records

numberOfVariableDatumRecords

protected long numberOfVariableDatumRecords

Number of variable datum records

fixedDatums

protected java.util.List<FixedDatum> fixedDatums

variable length list of fixed datums

variableDatums

protected java.util.List<VariableDatum> variableDatums

variable length list of variable length datums

Constructor Detail

ActionRequestPdu

public ActionRequestPdu()

Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()

Overrides:

getMarshalledSize in class SimulationManagementFamilyPdu

setOriginatingID

public void setOriginatingID(EntityID pOriginatingID)

getOriginatingID

public EntityID getOriginatingID()

setReceivingID

public void setReceivingID(EntityID pReceivingID)

getReceivingID

public EntityID getReceivingID()

setRequestID

public void setRequestID(long pRequestID)

getRequestID

public long getRequestID()

setActionID

public void setActionID(long pActionID)

getActionID

public long getActionID()

getNumberOfFixedDatumRecords

public long getNumberOfFixedDatumRecords()

setNumberOfFixedDatumRecords

public void setNumberOfFixedDatumRecords(long pNumberOfFixedDatumRecords)

Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose. The getnumberOfFixedDatumRecords method will also be based on the actual list length rather than this value. The method is simply here for java bean completeness.

getNumberOfVariableDatumRecords

public long getNumberOfVariableDatumRecords()

setNumberOfVariableDatumRecords

public void setNumberOfVariableDatumRecords(long pNumberOfVariableDatumRecords)

Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose. The getnumberOfVariableDatumRecords method will also be based on the actual list length rather than this value. The method is simply here for java bean completeness.

setFixedDatums

public void setFixedDatums(java.util.List<FixedDatum> pFixedDatums)

getFixedDatums

public java.util.List<FixedDatum> getFixedDatums()

setVariableDatums

public void setVariableDatums(java.util.List<VariableDatum> pVariableDatums)

getVariableDatums

public java.util.List<VariableDatum> getVariableDatums()

marshal

public void marshal(java.io.DataOutputStream dos)

Overrides:

marshal in class SimulationManagementFamilyPdu

unmarshal

public void unmarshal(java.io.DataInputStream dis)

Overrides:

unmarshal in class SimulationManagementFamilyPdu

marshal

public void marshal(java.nio.ByteBuffer buff)

Packs a Pdu into the ByteBuffer.

Overrides:

marshal in class SimulationManagementFamilyPdu

Parameters:

buff - The ByteBuffer at the position to begin writing

Throws:

java.nio.BufferOverflowException - if buff is too small

java.nio.ReadOnlyBufferException - if buff is read only

Since:

??

See Also:

ByteBuffer

unmarshal

public void unmarshal(java.nio.ByteBuffer buff)

Unpacks a Pdu from the underlying data.

Overrides:

unmarshal in class SimulationManagementFamilyPdu

Parameters:

buff - The ByteBuffer at the position to begin reading

Throws:

java.nio.BufferUnderflowException - if buff is too small

Since:

??

See Also:

ByteBuffer

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SimulationManagementFamilyPdu

equalsImpl

public boolean equalsImpl(java.lang.Object obj)

Description copied from class: PduSuperclass

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.