edu.nps.moves.dis
Class EntityStateUpdatePdu

java.lang.Object
  extended by edu.nps.moves.dis.Pdu
      extended by edu.nps.moves.dis.EntityInformationFamilyPdu
          extended by edu.nps.moves.dis.EntityStateUpdatePdu
All Implemented Interfaces:
java.io.Serializable

@Entity
public class EntityStateUpdatePdu
extends EntityInformationFamilyPdu
implements java.io.Serializable

5.3.3.4. Nonstatic information about a particular entity may be communicated by issuing an Entity State Update PDU. 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  java.util.List<ArticulationParameter> articulationParameters
           
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
          This field shall identify the entity issuing the PDU
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  Orientation entityOrientation
          describes the orientation of the entity, in euler angles
 long fk_entityID
           
 long fk_entityLinearVelocity
           
 long fk_entityLocation
           
 long fk_entityOrientation
           
protected  short numberOfArticulationParameters
          How many articulation parameters are in the variable length list
protected  byte padding1
          Padding
 
Fields inherited from class edu.nps.moves.dis.Pdu
exerciseID, padding, pduLength, pduType, protocolFamily, protocolVersion, timestamp
 
Constructor Summary
EntityStateUpdatePdu()
          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
 java.util.List<ArticulationParameter> getArticulationParameters()
           
 int getEntityAppearance()
           
 EntityID getEntityID()
           
 Vector3Float getEntityLinearVelocity()
           
 Vector3Double getEntityLocation()
           
 Orientation getEntityOrientation()
           
 int getMarshalledSize()
           
 short getNumberOfArticulationParameters()
           
 byte getPadding1()
           
 void marshal(java.nio.ByteBuffer buff)
          Packs a Pdu into the ByteBuffer.
 void marshal(java.io.DataOutputStream dos)
           
 void setArticulationParameters(java.util.List<ArticulationParameter> pArticulationParameters)
           
 void setEntityAppearance(int pEntityAppearance)
           
 void setEntityID(EntityID pEntityID)
           
 void setEntityLinearVelocity(Vector3Float pEntityLinearVelocity)
           
 void setEntityLocation(Vector3Double pEntityLocation)
           
 void setEntityOrientation(Orientation pEntityOrientation)
           
 void setNumberOfArticulationParameters(short pNumberOfArticulationParameters)
          Note that setting this value will not change the marshalled value.
 void setPadding1(byte pPadding1)
           
 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.dis.Pdu
getExerciseID, getLength, getPadding, getPduLength, getPduType, getPduTypeEnum, getPk_Pdu, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, marshalWithDisAbsoluteTimestamp, marshalWithDisAbsoluteTimestamp, marshalWithDisRelativeTimestamp, marshalWithDisRelativeTimestamp, marshalWithNpsTimestamp, marshalWithNpsTimestamp, marshalWithUnixTimestamp, marshalWithUnixTimestamp, readUnsignedInt, readUnsignedInt, setExerciseID, setPadding, setPduLength, setPduType, setPk_Pdu, setProtocolFamily, setProtocolVersion, setTimestamp
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

entityID

protected EntityID entityID
This field shall identify the entity issuing the PDU


padding1

protected byte padding1
Padding


numberOfArticulationParameters

protected short numberOfArticulationParameters
How many articulation parameters are in the variable length list


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 Orientation entityOrientation
describes the orientation of the entity, in euler angles


entityAppearance

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


articulationParameters

protected java.util.List<ArticulationParameter> articulationParameters

fk_entityID

public long fk_entityID

fk_entityLinearVelocity

public long fk_entityLinearVelocity

fk_entityLocation

public long fk_entityLocation

fk_entityOrientation

public long fk_entityOrientation
Constructor Detail

EntityStateUpdatePdu

public EntityStateUpdatePdu()
Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()
Overrides:
getMarshalledSize in class EntityInformationFamilyPdu

setEntityID

public void setEntityID(EntityID pEntityID)

getEntityID

public EntityID getEntityID()

setPadding1

public void setPadding1(byte pPadding1)

getPadding1

public byte getPadding1()

getNumberOfArticulationParameters

public short getNumberOfArticulationParameters()

setNumberOfArticulationParameters

public void setNumberOfArticulationParameters(short pNumberOfArticulationParameters)
Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose. The getnumberOfArticulationParameters method will also be based on the actual list length rather than this value. The method is simply here for java bean completeness.


setEntityLinearVelocity

public void setEntityLinearVelocity(Vector3Float pEntityLinearVelocity)

getEntityLinearVelocity

public Vector3Float getEntityLinearVelocity()

setEntityLocation

public void setEntityLocation(Vector3Double pEntityLocation)

getEntityLocation

public Vector3Double getEntityLocation()

setEntityOrientation

public void setEntityOrientation(Orientation pEntityOrientation)

getEntityOrientation

public Orientation getEntityOrientation()

setEntityAppearance

public void setEntityAppearance(int pEntityAppearance)

getEntityAppearance

public int getEntityAppearance()

setArticulationParameters

public void setArticulationParameters(java.util.List<ArticulationParameter> pArticulationParameters)

getArticulationParameters

public java.util.List<ArticulationParameter> getArticulationParameters()

marshal

public void marshal(java.io.DataOutputStream dos)
Overrides:
marshal in class EntityInformationFamilyPdu

unmarshal

public void unmarshal(java.io.DataInputStream dis)
Overrides:
unmarshal in class EntityInformationFamilyPdu

marshal

public void marshal(java.nio.ByteBuffer buff)
Packs a Pdu into the ByteBuffer.

Overrides:
marshal in class EntityInformationFamilyPdu
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 EntityInformationFamilyPdu
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 EntityInformationFamilyPdu

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, for this and the supplied object

Overrides:
equalsImpl in class EntityInformationFamilyPdu
Parameters:
obj - the object to compare to
Returns:
true if the objects are equal, false otherwise.