Enum Class ObjectKind

java.lang.Object
java.lang.Enum<ObjectKind>
edu.nps.moves.dis7.enumerations.ObjectKind
All Implemented Interfaces:
Serializable, Comparable<ObjectKind>, Constable
public enum ObjectKind extends Enum<ObjectKind>
This enum type is generated from XML, UID 225, marshal size 8; ObjectKind has 9 enumerations total.
See Also:

  • Enum Constant Details

    • OTHER

      public static final ObjectKind OTHER
      Other

    • OBSTACLE

      public static final ObjectKind OBSTACLE
      Obstacle

    • PREPARED_POSITION

      public static final ObjectKind PREPARED_POSITION
      Prepared Position

    • CULTURAL_FEATURE

      public static final ObjectKind CULTURAL_FEATURE
      Cultural Feature

    • PASSAGEWAY

      public static final ObjectKind PASSAGEWAY
      Passageway

    • TACTICAL_SMOKE

      public static final ObjectKind TACTICAL_SMOKE
      Tactical Smoke

    • OBSTACLE_MARKER

      public static final ObjectKind OBSTACLE_MARKER
      Obstacle Marker

    • OBSTACLE_BREACH

      public static final ObjectKind OBSTACLE_BREACH
      Obstacle Breach

    • ENVIRONMENTAL_OBJECT

      public static final ObjectKind ENVIRONMENTAL_OBJECT
      Environmental Object

  • Method Details

    • values

      public static ObjectKind[] 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 ObjectKind 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 ObjectKind 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:

    • 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:

    • unmarshalEnum

      public static ObjectKind 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:

    • unmarshalEnum

      public static ObjectKind 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:

    • getMarshalledSize

      public int getMarshalledSize()
      Returns size of this serialized (marshalled) object in bytes
      Returns:
      serialized size in bytes
      See Also:

    • getName

      public String getName()
      Provide name
      Returns:
      name

    • toString

      public String toString()
      Provide simple identifier
      Overrides:
      toString in class Enum<ObjectKind>
      Returns:
      class name, value and name