Enum SoilAttributeType

java.lang.Object
java.lang.Enum<SoilAttributeType>
edu.nps.moves.dis7.enumerations.SoilAttributeType
All Implemented Interfaces:
Serializable, Comparable<SoilAttributeType>, Constable

public enum SoilAttributeType extends Enum<SoilAttributeType>
This enum type is generated from XML, UID 495, marshal size 8; SoilAttributeType has 11 enumerations total.
See Also:
  • Enum Constant Details

    • CLAY_MASS

      public static final SoilAttributeType CLAY_MASS
      Clay Mass
    • CLAY_VOLUME_FRACTION

      public static final SoilAttributeType CLAY_VOLUME_FRACTION
      Clay Volume Fraction
    • SILT_MASS

      public static final SoilAttributeType SILT_MASS
      Silt Mass
    • SILT_VOLUME_FRACTION

      public static final SoilAttributeType SILT_VOLUME_FRACTION
      Silt Volume Fraction
    • SAND_MASS

      public static final SoilAttributeType SAND_MASS
      Sand Mass
    • SAND_VOLUME_FRACTION

      public static final SoilAttributeType SAND_VOLUME_FRACTION
      Sand Volume Fraction
    • GRAVEL_MASS

      public static final SoilAttributeType GRAVEL_MASS
      Gravel Mass
    • GRAVEL_VOLUME_FRACTION

      public static final SoilAttributeType GRAVEL_VOLUME_FRACTION
      Gravel Volume Fraction
    • WATER_MASS

      public static final SoilAttributeType WATER_MASS
      Water Mass
    • WATER_VOLUME_FRACTION

      public static final SoilAttributeType WATER_VOLUME_FRACTION
      Water Volume Fraction
    • WATER_PHASE

      public static final SoilAttributeType WATER_PHASE
      Water Phase
  • Method Details

    • values

      public static SoilAttributeType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static SoilAttributeType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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 SoilAttributeType 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 SoilAttributeType 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 SoilAttributeType 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<SoilAttributeType>
      Returns:
      class name, value and name