Class APA

java.lang.Object
edu.nps.moves.dis7.pdus.APA
All Implemented Interfaces:
Serializable

public class APA extends Object implements Serializable
Additional Passive Activity for use by Underwater Acoustic (UA) PDU. Section 7.6.4
See Also:
  • Field Details

    • parameterIndex

      protected short parameterIndex
      parameterIndex is an undescribed parameter...
    • value

      protected short value
      value is an undescribed parameter...
  • Constructor Details

    • APA

      public APA()
      Constructor creates and configures a new instance object
  • Method Details

    • getMarshalledSize

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

      public APA setParameterIndex(short pParameterIndex)
      Setter for parameterIndex
      Parameters:
      pParameterIndex - new value of interest
      Returns:
      same object to permit progressive setters
    • setParameterIndex

      public APA setParameterIndex(int pParameterIndex)
      Utility setter for parameterIndex
      Parameters:
      pParameterIndex - new value of interest
      Returns:
      same object to permit progressive setters
    • getParameterIndex

      public short getParameterIndex()
      Getter for parameterIndex
      Returns:
      value of interest
    • setValue

      public APA setValue(short pValue)
      Setter for value
      Parameters:
      pValue - new value of interest
      Returns:
      same object to permit progressive setters
    • setValue

      public APA setValue(int pValue)
      Utility setter for value
      Parameters:
      pValue - new value of interest
      Returns:
      same object to permit progressive setters
    • getValue

      public short getValue()
      Getter for value
      Returns:
      value of interest
    • marshal

      public void marshal(DataOutputStream dos) throws Exception
      Serializes an object to a DataOutputStream.
      Parameters:
      dos - the OutputStream
      Throws:
      Exception - if something goes wrong
      See Also:
    • unmarshal

      public int unmarshal(DataInputStream dis) throws Exception
      Deserializes an object from a DataInputStream.
      Parameters:
      dis - the InputStream
      Returns:
      marshalled serialized size in bytes
      Throws:
      Exception - if something goes wrong
      See Also:
    • marshal

      public void marshal(ByteBuffer byteBuffer) throws Exception
      Packs an object into the ByteBuffer.
      Parameters:
      byteBuffer - The ByteBuffer at the position to begin writing
      Throws:
      BufferOverflowException - if byteBuffer is too small
      ReadOnlyBufferException - if byteBuffer is read only
      Exception - ByteBuffer-generated exception
      See Also:
    • unmarshal

      public int unmarshal(ByteBuffer byteBuffer) throws Exception
      Unpacks a Pdu from the underlying data.
      Parameters:
      byteBuffer - The ByteBuffer at the position to begin reading
      Returns:
      marshalled serialized size in bytes
      Throws:
      BufferUnderflowException - if byteBuffer is too small
      Exception - ByteBuffer-generated exception
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsImpl

      public boolean equalsImpl(Object obj)
      Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
      Parameters:
      obj - the object to compare to
      Returns:
      true if the objects are equal, false otherwise.
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object