Class EntityStateUpdatePdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.EntityInformationInteractionFamilyPdu

edu.nps.moves.dis7.pdus.EntityStateUpdatePdu

All Implemented Interfaces:

Marshaller, Serializable

public class EntityStateUpdatePdu
extends EntityInformationInteractionFamilyPdu
implements Serializable

7.2.5. Nonstatic information about a particular entity may be communicated by issuing an Entity State Update PDU. 5.3.5.

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 ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected int	entityAppearance	This field shall specify the dynamic changes to the entity's appearance attributes.
protected EntityID	entityID	This field shall identify the entity issuing the PDU, and shall be represented by an Entity Identifier record (see 6.2.28).
protected Vector3Float	entityLinearVelocity	This field shall specify an entity's linear velocity.
protected Vector3Double	entityLocation	This field shall specify an entity's physical location in the simulated world and shall be represented by a World Coordinates record (see 6.2.97).
protected EulerAngles	entityOrientation	This field shall specify an entity's orientation with units of radians and shall be represented by an Euler Angles record (see 6.2.33).
static final String	NAME	The name of this PDU type
protected byte	numberOfVariableParameters	This field shall specify the number of variable parameters present.
protected byte	padding1	Padding
protected List<VariableParameter>	variableParameters	This field shall specify the parameter values for each Variable Parameter record that is included (see 6.2.93 and Annex I).

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

FAMILY_NAME

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
EntityStateUpdatePdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
EntityStateUpdatePdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
EntityStateUpdatePdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
EntityStateUpdatePdu	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
int	getEntityAppearance()	Getter for entityAppearance
EntityID	getEntityID()	Getter for entityID
Vector3Float	getEntityLinearVelocity()	Getter for entityLinearVelocity
Vector3Double	getEntityLocation()	Getter for entityLocation
EulerAngles	getEntityOrientation()	Getter for entityOrientation
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
byte	getPadding1()	Getter for padding1
List<VariableParameter>	getVariableParameters()	Getter for variableParameters
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
EntityStateUpdatePdu	setEntityAppearance(int pEntityAppearance)	Setter for entityAppearance
EntityStateUpdatePdu	setEntityID(EntityID pEntityID)	Setter for entityID
EntityStateUpdatePdu	setEntityLinearVelocity(Vector3Float pEntityLinearVelocity)	Setter for entityLinearVelocity
EntityStateUpdatePdu	setEntityLocation(Vector3Double pEntityLocation)	Setter for entityLocation
EntityStateUpdatePdu	setEntityOrientation(EulerAngles pEntityOrientation)	Setter for entityOrientation
EntityStateUpdatePdu	setPadding1(byte pPadding1)	Setter for padding1
EntityStateUpdatePdu	setPadding1(int pPadding1)	Utility setter for padding1
EntityStateUpdatePdu	setVariableParameters(List<VariableParameter> pVariableParameters)	Setter for variableParameters
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.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

entityID

protected EntityID entityID

This field shall identify the entity issuing the PDU, and shall be represented by an Entity Identifier record (see 6.2.28).

padding1

protected byte padding1

Padding

numberOfVariableParameters

protected byte numberOfVariableParameters

This field shall specify the number of variable parameters present. This field shall be represented by an 8-bit unsigned integer (see Annex I).

entityLinearVelocity

protected Vector3Float entityLinearVelocity

This field shall specify an entity's linear velocity. The coordinate system for an entity's linear velocity depends on the dead reckoning algorithm used. This field shall be represented by a Linear Velocity Vector record [see 6.2.95 item c)]).

entityLocation

protected Vector3Double entityLocation

This field shall specify an entity's physical location in the simulated world and shall be represented by a World Coordinates record (see 6.2.97).

entityOrientation

protected EulerAngles entityOrientation

This field shall specify an entity's orientation with units of radians and shall be represented by an Euler Angles record (see 6.2.33).

entityAppearance

protected int entityAppearance

This field shall specify the dynamic changes to the entity's appearance attributes. This field shall be represented by an Entity Appearance record (see 6.2.26).

variableParameters

protected List<VariableParameter> variableParameters

This field shall specify the parameter values for each Variable Parameter record that is included (see 6.2.93 and Annex I).

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

EntityStateUpdatePdu

public EntityStateUpdatePdu()

Constructor creates and configures a new instance object

Method Details

copy

public EntityStateUpdatePdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public EntityStateUpdatePdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public EntityStateUpdatePdu 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 EntityInformationInteractionFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setEntityID

public EntityStateUpdatePdu setEntityID(EntityID pEntityID)

Setter for entityID

Parameters:

pEntityID - new value of interest

Returns:

same object to permit progressive setters

getEntityID

public EntityID getEntityID()

Getter for entityID

Returns:

value of interest

setPadding1

public EntityStateUpdatePdu setPadding1(byte pPadding1)

Setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

setPadding1

public EntityStateUpdatePdu setPadding1(int pPadding1)

Utility setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

getPadding1

public byte getPadding1()

Getter for padding1

Returns:

value of interest

setEntityLinearVelocity

public EntityStateUpdatePdu setEntityLinearVelocity(Vector3Float pEntityLinearVelocity)

Setter for entityLinearVelocity

Parameters:

pEntityLinearVelocity - new value of interest

Returns:

same object to permit progressive setters

getEntityLinearVelocity

public Vector3Float getEntityLinearVelocity()

Getter for entityLinearVelocity

Returns:

value of interest

setEntityLocation

public EntityStateUpdatePdu setEntityLocation(Vector3Double pEntityLocation)

Setter for entityLocation

Parameters:

pEntityLocation - new value of interest

Returns:

same object to permit progressive setters

getEntityLocation

public Vector3Double getEntityLocation()

Getter for entityLocation

Returns:

value of interest

setEntityOrientation

public EntityStateUpdatePdu setEntityOrientation(EulerAngles pEntityOrientation)

Setter for entityOrientation

Parameters:

pEntityOrientation - new value of interest

Returns:

same object to permit progressive setters

getEntityOrientation

public EulerAngles getEntityOrientation()

Getter for entityOrientation

Returns:

value of interest

setEntityAppearance

public EntityStateUpdatePdu setEntityAppearance(int pEntityAppearance)

Setter for entityAppearance

Parameters:

pEntityAppearance - new value of interest

Returns:

same object to permit progressive setters

getEntityAppearance

public int getEntityAppearance()

Getter for entityAppearance

Returns:

value of interest

setVariableParameters

public EntityStateUpdatePdu setVariableParameters(List<VariableParameter> pVariableParameters)

Setter for variableParameters

Parameters:

pVariableParameters - new value of interest

Returns:

same object to permit progressive setters

getVariableParameters

public List<VariableParameter> getVariableParameters()

Getter for variableParameters

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class EntityInformationInteractionFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase