Enum Class ForceID

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

  • Enum Constant Details

    • OTHER

      public static final ForceID OTHER
      Other

    • FRIENDLY

      public static final ForceID FRIENDLY
      Friendly

    • OPPOSING

      public static final ForceID OPPOSING
      Opposing

    • NEUTRAL

      public static final ForceID NEUTRAL
      Neutral

    • FRIENDLY_2

      public static final ForceID FRIENDLY_2
      Friendly 2

    • OPPOSING_2

      public static final ForceID OPPOSING_2
      Opposing 2

    • NEUTRAL_2

      public static final ForceID NEUTRAL_2
      Neutral 2

    • FRIENDLY_3

      public static final ForceID FRIENDLY_3
      Friendly 3

    • OPPOSING_3

      public static final ForceID OPPOSING_3
      Opposing 3

    • NEUTRAL_3

      public static final ForceID NEUTRAL_3
      Neutral 3

    • FRIENDLY_4

      public static final ForceID FRIENDLY_4
      Friendly 4

    • OPPOSING_4

      public static final ForceID OPPOSING_4
      Opposing 4

    • NEUTRAL_4

      public static final ForceID NEUTRAL_4
      Neutral 4

    • FRIENDLY_5

      public static final ForceID FRIENDLY_5
      Friendly 5

    • OPPOSING_5

      public static final ForceID OPPOSING_5
      Opposing 5

    • NEUTRAL_5

      public static final ForceID NEUTRAL_5
      Neutral 5

    • FRIENDLY_6

      public static final ForceID FRIENDLY_6
      Friendly 6

    • OPPOSING_6

      public static final ForceID OPPOSING_6
      Opposing 6

    • NEUTRAL_6

      public static final ForceID NEUTRAL_6
      Neutral 6

    • FRIENDLY_7

      public static final ForceID FRIENDLY_7
      Friendly 7

    • OPPOSING_7

      public static final ForceID OPPOSING_7
      Opposing 7

    • NEUTRAL_7

      public static final ForceID NEUTRAL_7
      Neutral 7

    • FRIENDLY_8

      public static final ForceID FRIENDLY_8
      Friendly 8

    • OPPOSING_8

      public static final ForceID OPPOSING_8
      Opposing 8

    • NEUTRAL_8

      public static final ForceID NEUTRAL_8
      Neutral 8

    • FRIENDLY_9

      public static final ForceID FRIENDLY_9
      Friendly 9

    • OPPOSING_9

      public static final ForceID OPPOSING_9
      Opposing 9

    • NEUTRAL_9

      public static final ForceID NEUTRAL_9
      Neutral 9

    • IDENTIFICATION_FRIEND_OR_FOE

      public static final ForceID IDENTIFICATION_FRIEND_OR_FOE
      Friendly 10

    • OPPOSING_10

      public static final ForceID OPPOSING_10
      Opposing 10

    • SUPPLEMENTAL_EMISSION_ENTITY_STATE

      public static final ForceID SUPPLEMENTAL_EMISSION_ENTITY_STATE
      Neutral 10

  • Method Details

    • values

      public static ForceID[] 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 ForceID 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 ForceID 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 ForceID 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 ForceID 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<ForceID>
      Returns:
      class name, value and name