Class EntityStatePdu

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

All Implemented Interfaces:

Marshaller, Serializable

public class EntityStatePdu
extends EntityInformationInteractionFamilyPdu
implements Serializable

7.2.2. Represents the position and state of one entity in the world. See 5.3.2.

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EntityStatePdu.Direction	Direction enumerations

Field Summary

Fields

Modifier and Type	Field	Description
protected EntityType	alternativeEntityType	alternativeEntityType is an undescribed parameter...
protected ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected EntityCapabilities	capabilities	a series of bit flags uid 55
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected DeadReckoningParameters	deadReckoningParameters	parameters used for dead reckoning
protected int	entityAppearance	a series of bit flags that are used to help draw the entity, such as smoking, on fire, etc.
protected EntityID	entityID	Unique ID for an entity that is tied to this state information
protected Vector3Float	entityLinearVelocity	Describes the speed of the entity in the world
protected Vector3Double	entityLocation	describes the location of the entity in the world
protected EulerAngles	entityOrientation	describes the orientation of the entity, in euler angles with units of radians
protected EntityType	entityType	Describes the type of entity in the world
protected ForceID	forceId	What force this entity is affiliated with, eg red, blue, neutral, etc uid 6
protected EntityMarking	marking	11 characters that can be used for entity identification, debugging, or to draw unique strings on the side of entities in the world
static final String	NAME	The name of this PDU type
protected byte	numberOfVariableParameters	How many variable parameters are in the variable length list.
protected List<VariableParameter>	variableParameters	variable length list of variable parameters.

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

Method Summary

Modifier and Type	Method	Description
EntityStatePdu	advanceEntityLocation(double timestep)	Advance location using linear velocities for a single timestep
EntityStatePdu	clearMarking()	Marking utility to clear character values
EntityStatePdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
EntityStatePdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
EntityStatePdu	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
EntityType	getAlternativeEntityType()	Getter for alternativeEntityType
EntityCapabilities	getCapabilities()	Getter for capabilities
DeadReckoningParameters	getDeadReckoningParameters()	Getter for deadReckoningParameters
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
EntityType	getEntityType()	Getter for entityType
ForceID	getForceId()	Getter for forceId
EntityMarking	getMarking()	Getter for marking
String	getMarkingString()	Marking utility to get character values as a string
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
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.
EntityStatePdu	setAlternativeEntityType(EntityType pAlternativeEntityType)	Setter for alternativeEntityType
EntityStatePdu	setCapabilities(EntityCapabilities pCapabilities)	Setter for capabilities
EntityStatePdu	setDeadReckoningParameters(DeadReckoningParameters pDeadReckoningParameters)	Setter for deadReckoningParameters
EntityStatePdu	setEntityAppearance(int pEntityAppearance)	Setter for entityAppearance
EntityStatePdu	setEntityID(EntityID pEntityID)	Setter for entityID
final EntityStatePdu	setEntityLinearVelocity(float speed, EntityStatePdu.Direction direction)	Utility method to set entity linear velocity using speed and direction
EntityStatePdu	setEntityLinearVelocity(Vector3Float pEntityLinearVelocity)	Setter for entityLinearVelocity
EntityStatePdu	setEntityLocation(double x, double y, double z)	Setter for entityLocation
EntityStatePdu	setEntityLocation(Vector3Double pEntityLocation)	Setter for entityLocation
EntityStatePdu	setEntityOrientation(float phi, float theta, float psi)	Setter for entityOrientation
EntityStatePdu	setEntityOrientation(EulerAngles pEntityOrientation)	Setter for entityOrientation
EntityStatePdu	setEntityType(EntityType pEntityType)	Setter for entityType
EntityStatePdu	setForceId(ForceID pForceId)	Setter for forceId
EntityStatePdu	setMarking(EntityMarking pMarking)	Setter for marking
EntityStatePdu	setMarking(String newMarking)	Marking utility to set character values, 11 characters maximum
EntityStatePdu	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

Unique ID for an entity that is tied to this state information

forceId

protected ForceID forceId

What force this entity is affiliated with, eg red, blue, neutral, etc uid 6

numberOfVariableParameters

protected byte numberOfVariableParameters

How many variable parameters are in the variable length list. In earlier versions of DIS these were known as articulation parameters

entityType

protected EntityType entityType

Describes the type of entity in the world

alternativeEntityType

protected EntityType alternativeEntityType

alternativeEntityType is an undescribed parameter...

entityLinearVelocity

protected Vector3Float entityLinearVelocity

Describes the speed of the entity in the world

entityLocation

protected Vector3Double entityLocation

describes the location of the entity in the world

entityOrientation

protected EulerAngles entityOrientation

describes the orientation of the entity, in euler angles with units of radians

entityAppearance

protected int entityAppearance

a series of bit flags that are used to help draw the entity, such as smoking, on fire, etc.

deadReckoningParameters

protected DeadReckoningParameters deadReckoningParameters

parameters used for dead reckoning

marking

protected EntityMarking marking

11 characters that can be used for entity identification, debugging, or to draw unique strings on the side of entities in the world

capabilities

protected EntityCapabilities capabilities

a series of bit flags uid 55

variableParameters

protected List<VariableParameter> variableParameters

variable length list of variable parameters. In earlier DIS versions this was articulation parameters.

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

EntityStatePdu

public EntityStatePdu()

Constructor creates and configures a new instance object

Method Details

copy

public EntityStatePdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public EntityStatePdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public EntityStatePdu 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 EntityStatePdu 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

setForceId

public EntityStatePdu setForceId(ForceID pForceId)

Setter for forceId

Parameters:

pForceId - new value of interest

Returns:

same object to permit progressive setters

getForceId

public ForceID getForceId()

Getter for forceId

Returns:

value of interest

setEntityType

public EntityStatePdu setEntityType(EntityType pEntityType)

Setter for entityType

Parameters:

pEntityType - new value of interest

Returns:

same object to permit progressive setters

getEntityType

public EntityType getEntityType()

Getter for entityType

Returns:

value of interest

setAlternativeEntityType

public EntityStatePdu setAlternativeEntityType(EntityType pAlternativeEntityType)

Setter for alternativeEntityType

Parameters:

pAlternativeEntityType - new value of interest

Returns:

same object to permit progressive setters

getAlternativeEntityType

public EntityType getAlternativeEntityType()

Getter for alternativeEntityType

Returns:

value of interest

setEntityLinearVelocity

public EntityStatePdu 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 EntityStatePdu 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 EntityStatePdu 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 EntityStatePdu 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

setDeadReckoningParameters

public EntityStatePdu setDeadReckoningParameters(DeadReckoningParameters pDeadReckoningParameters)

Setter for deadReckoningParameters

Parameters:

pDeadReckoningParameters - new value of interest

Returns:

same object to permit progressive setters

getDeadReckoningParameters

public DeadReckoningParameters getDeadReckoningParameters()

Getter for deadReckoningParameters

Returns:

value of interest

setMarking

public EntityStatePdu setMarking(EntityMarking pMarking)

Setter for marking

Parameters:

pMarking - new value of interest

Returns:

same object to permit progressive setters

getMarking

public EntityMarking getMarking()

Getter for marking

Returns:

value of interest

setCapabilities

public EntityStatePdu setCapabilities(EntityCapabilities pCapabilities)

Setter for capabilities

Parameters:

pCapabilities - new value of interest

Returns:

same object to permit progressive setters

getCapabilities

public EntityCapabilities getCapabilities()

Getter for capabilities

Returns:

value of interest

setVariableParameters

public EntityStatePdu 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

setEntityLinearVelocity

public final EntityStatePdu setEntityLinearVelocity(float speed,
 EntityStatePdu.Direction direction)

Utility method to set entity linear velocity using speed and direction

Parameters:

speed - in meters/second

direction - using Directions enumerations

Returns:

same object to permit progressive setters

See Also:

• EntityStatePdu.Direction

setEntityLocation

public EntityStatePdu setEntityLocation(double x,
 double y,
 double z)

Setter for entityLocation

Parameters:

x - location

y - location

z - location

Returns:

same object to permit progressive setters

advanceEntityLocation

public EntityStatePdu advanceEntityLocation(double timestep)

Advance location using linear velocities for a single timestep

Parameters:

timestep - duration of travel

Returns:

same object to permit progressive setters

setEntityOrientation

public EntityStatePdu setEntityOrientation(float phi,
 float theta,
 float psi)

Setter for entityOrientation

Parameters:

phi - new value of interest

theta - new value of interest

psi - new value of interest

Returns:

same object to permit progressive setters

clearMarking

public EntityStatePdu clearMarking()

Marking utility to clear character values

Returns:

same object to permit progressive setters

setMarking

public EntityStatePdu setMarking(String newMarking)

Marking utility to set character values, 11 characters maximum

Parameters:

newMarking - new 11-character string to assign as marking value

Returns:

same object to permit progressive setters

getMarkingString

public String getMarkingString()

Marking utility to get character values as a string

Returns:

11-character String value corresponding to marking