FastEntityStatePdu

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

edu.nps.moves.dismobile
Class FastEntityStatePdu

java.lang.Object
  edu.nps.moves.dismobile.Pdu
      edu.nps.moves.dismobile.EntityInformationFamilyPdu
          edu.nps.moves.dismobile.FastEntityStatePdu

All Implemented Interfaces:: java.io.Serializable

public class FastEntityStatePdu
extends EntityInformationFamilyPdu
implements java.io.Serializable
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.dismobile.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.dismobile.Pdu
`getExerciseID, getLength, getPadding, getPduLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, marshalWithDisAbsoluteTimestamp, marshalWithDisAbsoluteTimestamp, marshalWithDisRelativeTimestamp, marshalWithDisRelativeTimestamp, marshalWithNpsTimestamp, marshalWithNpsTimestamp, marshalWithUnixTimestamp, marshalWithUnixTimestamp, readUnsignedInt, readUnsignedInt, setExerciseID, setPadding, setPduLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp`

Methods inherited from class edu.nps.moves.dismobile.Pdu

getExerciseID, getLength, getPadding, getPduLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, marshalWithDisAbsoluteTimestamp, marshalWithDisAbsoluteTimestamp, marshalWithDisRelativeTimestamp, marshalWithDisRelativeTimestamp, marshalWithNpsTimestamp, marshalWithNpsTimestamp, marshalWithUnixTimestamp, marshalWithUnixTimestamp, readUnsignedInt, readUnsignedInt, setExerciseID, setPadding, setPduLength, setPduType, 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

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