edu.nps.moves.dis
Class FastEntityStatePdu

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

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

Section 5.3.3.1. Represents the postion and state of one entity in the world. This is identical in function to entity state pdu, but generates less garbage to collect in the Java world. 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  short altCategory
          category of entity
protected  int altCountry
          country to which the design of the entity is attributed
protected  short altDomain
          Domain of entity (air, surface, subsurface, space, etc)
protected  short altEntityKind
          Kind of entity
protected  short altExtra
           
protected  short altSpecific
          specific info based on subcategory field
protected  short altSubcategory
          subcategory of entity
protected  int application
          The application ID
protected  java.util.List<ArticulationParameter> articulationParameters
          variable length list of articulation parameters
protected  int capabilities
          a series of bit flags
protected  short category
          category of entity
protected  int country
          country to which the design of the entity is attributed
protected  short deadReckoningAlgorithm
          enumeration of what dead reckoning algorighm to use
protected  short domain
          Domain of entity (air, surface, subsurface, space, etc)
protected  int entity
          the entity ID
protected  int entityAppearance
          a series of bit flags that are used to help draw the entity, such as smoking, on fire, etc.
protected  short entityKind
          Kind of entity
protected  short extra
           
protected  short forceId
          what force this entity is affiliated with, eg red, blue, neutral, etc
protected  byte[] marking
          characters that can be used for debugging, or to draw unique strings on the side of entities in the world
protected  byte numberOfArticulationParameters
          How many articulation parameters are in the variable length list
protected  byte[] otherParameters
          other parameters to use in the dead reckoning algorithm
protected  float phi
           
protected  float psi
           
protected  int site
          The site ID
protected  short specif
          specific info based on subcategory field.
protected  short subcategory
          subcategory of entity
protected  float theta
           
protected  float xAcceleration
          X value
protected  float xAngularVelocity
          X value
protected  double xLocation
          X value
protected  float xVelocity
          X velo
protected  float yAcceleration
          y Value
protected  float yAngularVelocity
          y Value
protected  double yLocation
          y Value
protected  float yVelocity
          y Value
protected  float zAcceleration
          Z value
protected  float zAngularVelocity
          Z value
protected  double zLocation
          Z value
protected  float zVelocity
          Z value
 
Fields inherited from class edu.nps.moves.dis.Pdu
exerciseID, padding, pduLength, pduType, protocolFamily, protocolVersion, timestamp
 
Constructor Summary
FastEntityStatePdu()
          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
 short getAltCategory()
           
 int getAltCountry()
           
 short getAltDomain()
           
 short getAltEntityKind()
           
 short getAltExtra()
           
 short getAltSpecific()
           
 short getAltSubcategory()
           
 int getApplication()
           
 java.util.List<ArticulationParameter> getArticulationParameters()
           
 int getCapabilities()
           
 short getCategory()
           
 int getCountry()
           
 short getDeadReckoningAlgorithm()
           
 short getDomain()
           
 int getEntity()
           
 int getEntityAppearance()
           
 short getEntityKind()
           
 short getExtra()
           
 short getForceId()
           
 byte[] getMarking()
           
 int getMarshalledSize()
           
 byte getNumberOfArticulationParameters()
           
 byte[] getOtherParameters()
           
 float getPhi()
           
 float getPsi()
           
 int getSite()
           
 short getSpecif()
           
 short getSubcategory()
           
 float getTheta()
           
 float getXAcceleration()
           
 float getXAngularVelocity()
           
 double getXLocation()
           
 float getXVelocity()
           
 float getYAcceleration()
           
 float getYAngularVelocity()
           
 double getYLocation()
           
 float getYVelocity()
           
 float getZAcceleration()
           
 float getZAngularVelocity()
           
 double getZLocation()
           
 float getZVelocity()
           
 void marshal(java.nio.ByteBuffer buff)
          Packs a Pdu into the ByteBuffer.
 void marshal(java.io.DataOutputStream dos)
           
 void setAltCategory(short pAltCategory)
           
 void setAltCountry(int pAltCountry)
           
 void setAltDomain(short pAltDomain)
           
 void setAltEntityKind(short pAltEntityKind)
           
 void setAltExtra(short pAltExtra)
           
 void setAltSpecific(short pAltSpecific)
           
 void setAltSubcategory(short pAltSubcategory)
           
 void setApplication(int pApplication)
           
 void setArticulationParameters(java.util.List<ArticulationParameter> pArticulationParameters)
           
 void setCapabilities(int pCapabilities)
           
 void setCategory(short pCategory)
           
 void setCountry(int pCountry)
           
 void setDeadReckoningAlgorithm(short pDeadReckoningAlgorithm)
           
 void setDomain(short pDomain)
           
 void setEntity(int pEntity)
           
 void setEntityAppearance(int pEntityAppearance)
           
 void setEntityKind(short pEntityKind)
           
 void setExtra(short pExtra)
           
 void setForceId(short pForceId)
           
 void setMarking(byte[] pMarking)
           
 void setNumberOfArticulationParameters(byte pNumberOfArticulationParameters)
          Note that setting this value will not change the marshalled value.
 void setOtherParameters(byte[] pOtherParameters)
           
 void setPhi(float pPhi)
           
 void setPsi(float pPsi)
           
 void setSite(int pSite)
           
 void setSpecif(short pSpecif)
           
 void setSubcategory(short pSubcategory)
           
 void setTheta(float pTheta)
           
 void setXAcceleration(float pXAcceleration)
           
 void setXAngularVelocity(float pXAngularVelocity)
           
 void setXLocation(double pXLocation)
           
 void setXVelocity(float pXVelocity)
           
 void setYAcceleration(float pYAcceleration)
           
 void setYAngularVelocity(float pYAngularVelocity)
           
 void setYLocation(double pYLocation)
           
 void setYVelocity(float pYVelocity)
           
 void setZAcceleration(float pZAcceleration)
           
 void setZAngularVelocity(float pZAngularVelocity)
           
 void setZLocation(double pZLocation)
           
 void setZVelocity(float pZVelocity)
           
 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

site

protected int site
The site ID


application

protected int application
The application ID


entity

protected int entity
the entity ID


forceId

protected short forceId
what force this entity is affiliated with, eg red, blue, neutral, etc


numberOfArticulationParameters

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


entityKind

protected short entityKind
Kind of entity


domain

protected short domain
Domain of entity (air, surface, subsurface, space, etc)


country

protected int country
country to which the design of the entity is attributed


category

protected short category
category of entity


subcategory

protected short subcategory
subcategory of entity


specif

protected short specif
specific info based on subcategory field. Name changed from specific because that is a reserved word in SQL.


extra

protected short extra

altEntityKind

protected short altEntityKind
Kind of entity


altDomain

protected short altDomain
Domain of entity (air, surface, subsurface, space, etc)


altCountry

protected int altCountry
country to which the design of the entity is attributed


altCategory

protected short altCategory
category of entity


altSubcategory

protected short altSubcategory
subcategory of entity


altSpecific

protected short altSpecific
specific info based on subcategory field


altExtra

protected short altExtra

xVelocity

protected float xVelocity
X velo


yVelocity

protected float yVelocity
y Value


zVelocity

protected float zVelocity
Z value


xLocation

protected double xLocation
X value


yLocation

protected double yLocation
y Value


zLocation

protected double zLocation
Z value


psi

protected float psi

theta

protected float theta

phi

protected float phi

entityAppearance

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


deadReckoningAlgorithm

protected short deadReckoningAlgorithm
enumeration of what dead reckoning algorighm to use


otherParameters

protected byte[] otherParameters
other parameters to use in the dead reckoning algorithm


xAcceleration

protected float xAcceleration
X value


yAcceleration

protected float yAcceleration
y Value


zAcceleration

protected float zAcceleration
Z value


xAngularVelocity

protected float xAngularVelocity
X value


yAngularVelocity

protected float yAngularVelocity
y Value


zAngularVelocity

protected float zAngularVelocity
Z value


marking

protected byte[] marking
characters that can be used for debugging, or to draw unique strings on the side of entities in the world


capabilities

protected int capabilities
a series of bit flags


articulationParameters

protected java.util.List<ArticulationParameter> articulationParameters
variable length list of articulation parameters

Constructor Detail

FastEntityStatePdu

public FastEntityStatePdu()
Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()
Overrides:
getMarshalledSize in class EntityInformationFamilyPdu

setSite

public void setSite(int pSite)

getSite

public int getSite()

setApplication

public void setApplication(int pApplication)

getApplication

public int getApplication()

setEntity

public void setEntity(int pEntity)

getEntity

public int getEntity()

setForceId

public void setForceId(short pForceId)

getForceId

public short getForceId()

getNumberOfArticulationParameters

public byte getNumberOfArticulationParameters()

setNumberOfArticulationParameters

public void setNumberOfArticulationParameters(byte 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.


setEntityKind

public void setEntityKind(short pEntityKind)

getEntityKind

public short getEntityKind()

setDomain

public void setDomain(short pDomain)

getDomain

public short getDomain()

setCountry

public void setCountry(int pCountry)

getCountry

public int getCountry()

setCategory

public void setCategory(short pCategory)

getCategory

public short getCategory()

setSubcategory

public void setSubcategory(short pSubcategory)

getSubcategory

public short getSubcategory()

setSpecif

public void setSpecif(short pSpecif)

getSpecif

public short getSpecif()

setExtra

public void setExtra(short pExtra)

getExtra

public short getExtra()

setAltEntityKind

public void setAltEntityKind(short pAltEntityKind)

getAltEntityKind

public short getAltEntityKind()

setAltDomain

public void setAltDomain(short pAltDomain)

getAltDomain

public short getAltDomain()

setAltCountry

public void setAltCountry(int pAltCountry)

getAltCountry

public int getAltCountry()

setAltCategory

public void setAltCategory(short pAltCategory)

getAltCategory

public short getAltCategory()

setAltSubcategory

public void setAltSubcategory(short pAltSubcategory)

getAltSubcategory

public short getAltSubcategory()

setAltSpecific

public void setAltSpecific(short pAltSpecific)

getAltSpecific

public short getAltSpecific()

setAltExtra

public void setAltExtra(short pAltExtra)

getAltExtra

public short getAltExtra()

setXVelocity

public void setXVelocity(float pXVelocity)

getXVelocity

public float getXVelocity()

setYVelocity

public void setYVelocity(float pYVelocity)

getYVelocity

public float getYVelocity()

setZVelocity

public void setZVelocity(float pZVelocity)

getZVelocity

public float getZVelocity()

setXLocation

public void setXLocation(double pXLocation)

getXLocation

public double getXLocation()

setYLocation

public void setYLocation(double pYLocation)

getYLocation

public double getYLocation()

setZLocation

public void setZLocation(double pZLocation)

getZLocation

public double getZLocation()

setPsi

public void setPsi(float pPsi)

getPsi

public float getPsi()

setTheta

public void setTheta(float pTheta)

getTheta

public float getTheta()

setPhi

public void setPhi(float pPhi)

getPhi

public float getPhi()

setEntityAppearance

public void setEntityAppearance(int pEntityAppearance)

getEntityAppearance

public int getEntityAppearance()

setDeadReckoningAlgorithm

public void setDeadReckoningAlgorithm(short pDeadReckoningAlgorithm)

getDeadReckoningAlgorithm

public short getDeadReckoningAlgorithm()

setOtherParameters

public void setOtherParameters(byte[] pOtherParameters)

getOtherParameters

public byte[] getOtherParameters()

setXAcceleration

public void setXAcceleration(float pXAcceleration)

getXAcceleration

public float getXAcceleration()

setYAcceleration

public void setYAcceleration(float pYAcceleration)

getYAcceleration

public float getYAcceleration()

setZAcceleration

public void setZAcceleration(float pZAcceleration)

getZAcceleration

public float getZAcceleration()

setXAngularVelocity

public void setXAngularVelocity(float pXAngularVelocity)

getXAngularVelocity

public float getXAngularVelocity()

setYAngularVelocity

public void setYAngularVelocity(float pYAngularVelocity)

getYAngularVelocity

public float getYAngularVelocity()

setZAngularVelocity

public void setZAngularVelocity(float pZAngularVelocity)

getZAngularVelocity

public float getZAngularVelocity()

setMarking

public void setMarking(byte[] pMarking)

getMarking

public byte[] getMarking()

setCapabilities

public void setCapabilities(int pCapabilities)

getCapabilities

public int getCapabilities()

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.