Enum Class DeadReckoningAlgorithm

java.lang.Object

java.lang.Enum<DeadReckoningAlgorithm>

edu.nps.moves.dis7.enumerations.DeadReckoningAlgorithm

All Implemented Interfaces:

Serializable, Comparable<DeadReckoningAlgorithm>, Constable

public enum DeadReckoningAlgorithm
extends Enum<DeadReckoningAlgorithm>

This enum type is generated from XML, UID 44, marshal size 8; DeadReckoningAlgorithm has 10 enumerations total.

See Also:

• Java Tutorials: Enum Types
• Enum

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DRM_FPB_SIMILAR_TO_FPW_EXCEPT_IN_BODY_COORDINATES	DRM (FPB) - Similar to FPW except in Body Coordinates
DRM_FPW_CONSTANT_VELOCITY_LOW_ACCELERATION_LINEAR_MOTION_ENTITY	DRM (FPW) - Constant Velocity / Low Acceleration Linear Motion Entity
DRM_FVB_SIMILAR_TO_FVW_EXCEPT_IN_BODY_COORDINATES	DRM (FVB) - Similar to FVW except in Body Coordinates
DRM_FVW_HIGH_SPEED_OR_MANEUVERING_ENTITY	DRM (FVW) - High Speed or Maneuvering Entity
DRM_RPB_SIMILAR_TO_RPW_EXCEPT_IN_BODY_COORDINATES	DRM (RPB) - Similar to RPW except in Body Coordinates
DRM_RPW_CONSTANT_VELOCITY_LOW_ACCELERATION_LINEAR_MOTION_ENTITY_WITH_EXTRAPOLATION_OF_ORIENTATION	DRM (RPW) - Constant Velocity / Low Acceleration Linear Motion Entity with Extrapolation of Orientation
DRM_RVB_SIMILAR_TO_RVW_EXCEPT_IN_BODY_COORDINATES	DRM (RVB) - Similar to RVW except in Body Coordinates
DRM_RVW_HIGH_SPEED_OR_MANEUVERING_ENTITY_WITH_EXTRAPOLATION_OF_ORIENTATION	DRM (RVW) - High Speed or Maneuvering Entity with Extrapolation of Orientation
OTHER	Other
STATIC_NON_MOVING_ENTITY	Static - Non-moving Entity

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Provide enumeration description
static int	getEnumBitWidth()	bit width for this enumeration
static DeadReckoningAlgorithm	getEnumForValue(int value)	Provide enumeration for a given value
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
String	getName()	Provide name
boolean	getTRACE()	Whether tracing is on or off for this object
int	getValue()	Provide enumeration value
void	marshal(DataOutputStream dos)	Marshal value to DataOutputStream
void	marshal(ByteBuffer byteBuffer)	Marshal value to ByteBuffer
void	setTRACE(boolean value)	Set tracing on/off for this object
String	toString()	Provide simple identifier
static DeadReckoningAlgorithm	unmarshalEnum(DataInputStream dis)	Unmarshal value to DataInputStream
static DeadReckoningAlgorithm	unmarshalEnum(ByteBuffer byteBuffer)	Unmarshal enumeration value to ByteBuffer
static DeadReckoningAlgorithm	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DeadReckoningAlgorithm[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OTHER

public static final DeadReckoningAlgorithm OTHER

Other

STATIC_NON_MOVING_ENTITY

public static final DeadReckoningAlgorithm STATIC_NON_MOVING_ENTITY

Static - Non-moving Entity

DRM_FPW_CONSTANT_VELOCITY_LOW_ACCELERATION_LINEAR_MOTION_ENTITY

public static final DeadReckoningAlgorithm DRM_FPW_CONSTANT_VELOCITY_LOW_ACCELERATION_LINEAR_MOTION_ENTITY

DRM (FPW) - Constant Velocity / Low Acceleration Linear Motion Entity

DRM_RPW_CONSTANT_VELOCITY_LOW_ACCELERATION_LINEAR_MOTION_ENTITY_WITH_EXTRAPOLATION_OF_ORIENTATION

public static final DeadReckoningAlgorithm DRM_RPW_CONSTANT_VELOCITY_LOW_ACCELERATION_LINEAR_MOTION_ENTITY_WITH_EXTRAPOLATION_OF_ORIENTATION

DRM (RPW) - Constant Velocity / Low Acceleration Linear Motion Entity with Extrapolation of Orientation

DRM_RVW_HIGH_SPEED_OR_MANEUVERING_ENTITY_WITH_EXTRAPOLATION_OF_ORIENTATION

public static final DeadReckoningAlgorithm DRM_RVW_HIGH_SPEED_OR_MANEUVERING_ENTITY_WITH_EXTRAPOLATION_OF_ORIENTATION

DRM (RVW) - High Speed or Maneuvering Entity with Extrapolation of Orientation

DRM_FVW_HIGH_SPEED_OR_MANEUVERING_ENTITY

public static final DeadReckoningAlgorithm DRM_FVW_HIGH_SPEED_OR_MANEUVERING_ENTITY

DRM (FVW) - High Speed or Maneuvering Entity

DRM_FPB_SIMILAR_TO_FPW_EXCEPT_IN_BODY_COORDINATES

public static final DeadReckoningAlgorithm DRM_FPB_SIMILAR_TO_FPW_EXCEPT_IN_BODY_COORDINATES

DRM (FPB) - Similar to FPW except in Body Coordinates

DRM_RPB_SIMILAR_TO_RPW_EXCEPT_IN_BODY_COORDINATES

public static final DeadReckoningAlgorithm DRM_RPB_SIMILAR_TO_RPW_EXCEPT_IN_BODY_COORDINATES

DRM (RPB) - Similar to RPW except in Body Coordinates

DRM_RVB_SIMILAR_TO_RVW_EXCEPT_IN_BODY_COORDINATES

public static final DeadReckoningAlgorithm DRM_RVB_SIMILAR_TO_RVW_EXCEPT_IN_BODY_COORDINATES

DRM (RVB) - Similar to RVW except in Body Coordinates

DRM_FVB_SIMILAR_TO_FVW_EXCEPT_IN_BODY_COORDINATES

public static final DeadReckoningAlgorithm DRM_FVB_SIMILAR_TO_FVW_EXCEPT_IN_BODY_COORDINATES

DRM (FVB) - Similar to FVW except in Body Coordinates

Method Details

values

public static DeadReckoningAlgorithm[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DeadReckoningAlgorithm valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Provide enumeration value

Returns:

integer value

getDescription

public String getDescription()

Provide enumeration description

Returns:

description

getEnumBitWidth

public static int getEnumBitWidth()

bit width for this enumeration

Returns:

number of bits wide

getEnumForValue

public static DeadReckoningAlgorithm getEnumForValue(int value)

Provide enumeration for a given value

Parameters:

value - integer value of interest

Returns:

enumeration corresponding to numeric value

setTRACE

public void setTRACE(boolean value)

Set tracing on/off for this object

Parameters:

value - whether tracing is on or off

getTRACE

public boolean getTRACE()

Whether tracing is on or off for this object

Returns:

whether tracing is on or off

marshal

public void marshal(DataOutputStream dos)
             throws IOException

Marshal value to DataOutputStream

Parameters:

dos - DataOutputStream for output

Throws:

IOException - input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

marshal

public void marshal(ByteBuffer byteBuffer)
             throws Exception

Marshal value to ByteBuffer

Parameters:

byteBuffer - ByteBuffer for output

Throws:

IOException - input-output error

Exception

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

unmarshalEnum

public static DeadReckoningAlgorithm unmarshalEnum(DataInputStream dis)
                                            throws Exception

Unmarshal value to DataInputStream

Parameters:

dis - DataInputStream for input

Returns:

enumeration of interest

Throws:

Exception - unmarshalling input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

unmarshalEnum

public static DeadReckoningAlgorithm unmarshalEnum(ByteBuffer byteBuffer)
                                            throws Exception

Unmarshal enumeration value to ByteBuffer

Parameters:

byteBuffer - ByteBuffer for input

Returns:

enumeration of interest

Throws:

Exception - unmarshalling input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Returns:

serialized size in bytes

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

getName

public String getName()

Provide name

Returns:

name

toString

public String toString()

Provide simple identifier

Overrides:

toString in class Enum<DeadReckoningAlgorithm>

Returns:

class name, value and name