Package edu.nps.moves.dis7
Class EntityStatePdu
java.lang.Object
edu.nps.moves.dis7.Pdu
edu.nps.moves.dis7.PduBase
edu.nps.moves.dis7.EntityInformationFamilyPdu
edu.nps.moves.dis7.EntityStatePdu
- All Implemented Interfaces:
edu.nps.moves.dis7.Marshaller
,java.io.Serializable
public class EntityStatePdu extends EntityInformationFamilyPdu implements java.io.Serializable
7.2.2. Represents the postion and state of one entity in the world. See 5.3.2.
IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation—Application Protocols
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description protected EntityType
alternativeEntityType
protected edu.nps.moves.dis7.EntityCapabilities
capabilities
a series of bit flags uid 55protected DeadReckoningParameters
deadReckoningParameters
parameters used for dead reckoningprotected 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 informationprotected Vector3Float
entityLinearVelocity
Describes the speed of the entity in the worldprotected Vector3Double
entityLocation
describes the location of the entity in the worldprotected EulerAngles
entityOrientation
describes the orientation of the entity, in euler anglesprotected EntityType
entityType
Describes the type of entity in the worldprotected ForceID
forceId
What force this entity is affiliated with, eg red, blue, neutral, etc uid 6protected EntityMarking
marking
characters that can be used for debugging, or to draw unique strings on the side of entities in the worldprotected byte
numberOfVariableParameters
How many variable parameters are in the variable length list.protected java.util.List<VariableParameter>
variableParameters
variable length list of variable parameters.Fields inherited from class edu.nps.moves.dis7.Pdu
exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp
-
Constructor Summary
Constructors Constructor Description EntityStatePdu()
Constructor -
Method Summary
Modifier and Type Method Description 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, forthis
and the supplied objectEntityType
getAlternativeEntityType()
Getter foralternativeEntityType
edu.nps.moves.dis7.EntityCapabilities
getCapabilities()
Setter forcapabilities
DeadReckoningParameters
getDeadReckoningParameters()
Getter fordeadReckoningParameters
int
getEntityAppearance()
Getter forentityAppearance
EntityID
getEntityID()
Getter forentityID
Vector3Float
getEntityLinearVelocity()
Getter forentityLinearVelocity
Vector3Double
getEntityLocation()
Getter forentityLocation
EulerAngles
getEntityOrientation()
Getter forentityOrientation
EntityType
getEntityType()
Getter forentityType
ForceID
getForceId()
Getter forforceId
EntityMarking
getMarking()
Getter formarking
int
getMarshalledSize()
Returns the size of this serialized object in bytesjava.util.List<VariableParameter>
getVariableParameters()
Getter forvariableParameters
void
marshal(java.io.DataOutputStream dos)
Serializes an object to a DataOutputStream.void
marshal(java.nio.ByteBuffer buff)
Packs an object into the ByteBuffer.EntityStatePdu
setAlternativeEntityType(EntityType pAlternativeEntityType)
Setter foralternativeEntityType
EntityStatePdu
setCapabilities(edu.nps.moves.dis7.EntityCapabilities pCapabilities)
Setter forcapabilities
EntityStatePdu
setDeadReckoningParameters(DeadReckoningParameters pDeadReckoningParameters)
Setter fordeadReckoningParameters
EntityStatePdu
setEntityAppearance(int pEntityAppearance)
Setter forentityAppearance
EntityStatePdu
setEntityID(EntityID pEntityID)
Setter forentityID
EntityStatePdu
setEntityLinearVelocity(Vector3Float pEntityLinearVelocity)
Setter forentityLinearVelocity
EntityStatePdu
setEntityLocation(Vector3Double pEntityLocation)
Setter forentityLocation
EntityStatePdu
setEntityOrientation(EulerAngles pEntityOrientation)
Setter forentityOrientation
EntityStatePdu
setEntityType(EntityType pEntityType)
Setter forentityType
EntityStatePdu
setForceId(ForceID pForceId)
Setter forforceId
EntityStatePdu
setMarking(EntityMarking pMarking)
Setter formarking
EntityStatePdu
setVariableParameters(java.util.List<VariableParameter> pVariableParameters)
Setter forvariableParameters
java.lang.String
toString()
int
unmarshal(java.io.DataInputStream dis)
Unserializes an object from a DataInputStream.int
unmarshal(java.nio.ByteBuffer buff)
Unpacks a Pdu from the underlying data.Methods inherited from class edu.nps.moves.dis7.PduBase
getPadding, getPduStatus, setPadding, setPduStatus
Methods inherited from class edu.nps.moves.dis7.Pdu
getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, setExerciseID, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp
-
Field Details
-
entityID
Unique ID for an entity that is tied to this state information -
forceId
What force this entity is affiliated with, eg red, blue, neutral, etc uid 6 -
numberOfVariableParameters
protected byte numberOfVariableParametersHow many variable parameters are in the variable length list. In earlier versions of DIS these were known as articulation parameters -
entityType
Describes the type of entity in the world -
alternativeEntityType
-
entityLinearVelocity
Describes the speed of the entity in the world -
entityLocation
describes the location of the entity in the world -
entityOrientation
describes the orientation of the entity, in euler angles -
entityAppearance
protected int entityAppearancea series of bit flags that are used to help draw the entity, such as smoking, on fire, etc. -
deadReckoningParameters
parameters used for dead reckoning -
marking
characters that can be used for debugging, or to draw unique strings on the side of entities in the world -
capabilities
protected edu.nps.moves.dis7.EntityCapabilities capabilitiesa series of bit flags uid 55 -
variableParameters
variable length list of variable parameters. In earlier DIS versions this was articulation parameters.
-
-
Constructor Details
-
EntityStatePdu
public EntityStatePdu()Constructor
-
-
Method Details
-
getMarshalledSize
public int getMarshalledSize()Returns the size of this serialized object in bytes- Specified by:
getMarshalledSize
in interfaceedu.nps.moves.dis7.Marshaller
- Overrides:
getMarshalledSize
in classEntityInformationFamilyPdu
-
setEntityID
Setter forentityID
-
getEntityID
Getter forentityID
-
setForceId
Setter forforceId
-
getForceId
Getter forforceId
-
setEntityType
Setter forentityType
-
getEntityType
Getter forentityType
-
setAlternativeEntityType
Setter foralternativeEntityType
-
getAlternativeEntityType
Getter foralternativeEntityType
-
setEntityLinearVelocity
Setter forentityLinearVelocity
-
getEntityLinearVelocity
Getter forentityLinearVelocity
-
setEntityLocation
Setter forentityLocation
-
getEntityLocation
Getter forentityLocation
-
setEntityOrientation
Setter forentityOrientation
-
getEntityOrientation
Getter forentityOrientation
-
setEntityAppearance
Setter forentityAppearance
-
getEntityAppearance
public int getEntityAppearance()Getter forentityAppearance
-
setDeadReckoningParameters
Setter fordeadReckoningParameters
-
getDeadReckoningParameters
Getter fordeadReckoningParameters
-
setMarking
Setter formarking
-
getMarking
Getter formarking
-
setCapabilities
Setter forcapabilities
-
getCapabilities
public edu.nps.moves.dis7.EntityCapabilities getCapabilities()Setter forcapabilities
-
setVariableParameters
Setter forvariableParameters
-
getVariableParameters
Getter forvariableParameters
-
marshal
public void marshal(java.io.DataOutputStream dos) throws java.lang.ExceptionSerializes an object to a DataOutputStream.- Specified by:
marshal
in interfaceedu.nps.moves.dis7.Marshaller
- Overrides:
marshal
in classEntityInformationFamilyPdu
- Parameters:
dos
- the OutputStream- Throws:
java.lang.Exception
- if something goes wrong- See Also:
DataOutputStream
-
unmarshal
public int unmarshal(java.io.DataInputStream dis) throws java.lang.ExceptionUnserializes an object from a DataInputStream.- Specified by:
unmarshal
in interfaceedu.nps.moves.dis7.Marshaller
- Overrides:
unmarshal
in classEntityInformationFamilyPdu
- Parameters:
dis
- the InputStream- Returns:
- unmarshalled size
- Throws:
java.lang.Exception
- if something goes wrong- See Also:
DataInputStream
-
marshal
public void marshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionPacks an object into the ByteBuffer.- Specified by:
marshal
in interfaceedu.nps.moves.dis7.Marshaller
- Overrides:
marshal
in classEntityInformationFamilyPdu
- Parameters:
buff
- The ByteBuffer at the position to begin writing- Throws:
java.nio.BufferOverflowException
- if buff is too smalljava.nio.ReadOnlyBufferException
- if buff is read onlyjava.lang.Exception
- ByteBuffer-generated exception- See Also:
ByteBuffer
-
unmarshal
public int unmarshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionUnpacks a Pdu from the underlying data.- Specified by:
unmarshal
in interfaceedu.nps.moves.dis7.Marshaller
- Overrides:
unmarshal
in classEntityInformationFamilyPdu
- Parameters:
buff
- The ByteBuffer at the position to begin reading- Returns:
- marshalled size
- Throws:
java.nio.BufferUnderflowException
- if buff is too smalljava.lang.Exception
- ByteBuffer-generated exception- See Also:
ByteBuffer
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classEntityInformationFamilyPdu
-
equalsImpl
public boolean equalsImpl(java.lang.Object obj)Description copied from class:Pdu
Compare all fields that contribute to the state, ignoring transient and static fields, forthis
and the supplied object- Overrides:
equalsImpl
in classEntityInformationFamilyPdu
- Parameters:
obj
- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
public java.lang.String toString()- Overrides:
toString
in classEntityInformationFamilyPdu
-