Enum Class DamageArea

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

  • Enum Constant Details

    • DAMAGE_AREA_1_DEFAULT_IS_SIDE_1__FRONT_SIDE_OR_NOT_APPLICABLE_IF_DAMAGE_AREAS_ARE_NOT_DEFINED

      public static final DamageArea DAMAGE_AREA_1_DEFAULT_IS_SIDE_1__FRONT_SIDE_OR_NOT_APPLICABLE_IF_DAMAGE_AREAS_ARE_NOT_DEFINED
      Damage Area 1 (default is Side 1 = Front Side) or Not Applicable if Damage Areas are not defined.

    • DAMAGE_AREA_2_DEFAULT_IS_SIDE_2__RIGHT_SIDE

      public static final DamageArea DAMAGE_AREA_2_DEFAULT_IS_SIDE_2__RIGHT_SIDE
      Damage Area 2 (default is Side 2 = Right Side)

    • DAMAGE_AREA_3_DEFAULT_IS_SIDE_3__BACK_SIDE

      public static final DamageArea DAMAGE_AREA_3_DEFAULT_IS_SIDE_3__BACK_SIDE
      Damage Area 3 (default is Side 3 = Back Side)

    • DAMAGE_AREA_4_DEFAULT_IS_SIDE_4__LEFT_SIDE

      public static final DamageArea DAMAGE_AREA_4_DEFAULT_IS_SIDE_4__LEFT_SIDE
      Damage Area 4 (default is Side 4 = Left Side)

    • DAMAGE_AREA_5_DEFAULT_IS_CORNER_1__FRONT_RIGHT_CORNER

      public static final DamageArea DAMAGE_AREA_5_DEFAULT_IS_CORNER_1__FRONT_RIGHT_CORNER
      Damage Area 5 (default is Corner 1 = Front Right Corner)

    • DAMAGE_AREA_6_DEFAULT_IS_CORNER_2__BACK_RIGHT_CORNER

      public static final DamageArea DAMAGE_AREA_6_DEFAULT_IS_CORNER_2__BACK_RIGHT_CORNER
      Damage Area 6 (default is Corner 2 = Back Right Corner)

    • DAMAGE_AREA_7_DEFAULT_IS_CORNER_3__BACK_LEFT_CORNER

      public static final DamageArea DAMAGE_AREA_7_DEFAULT_IS_CORNER_3__BACK_LEFT_CORNER
      Damage Area 7 (default is Corner 3 = Back Left Corner)

    • DAMAGE_AREA_8_DEFAULT_IS_CORNER_4__FRONT_LEFT_CORNER

      public static final DamageArea DAMAGE_AREA_8_DEFAULT_IS_CORNER_4__FRONT_LEFT_CORNER
      Damage Area 8 (default is Corner 4 = Front Left Corner)

  • Method Details

    • values

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