Class ShaftRPM

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

public class ShaftRPM extends Object implements Serializable
Current Shaft RPM, Ordered Shaft RPM for use by Underwater Acoustic (UA) PDU. Section 7.6.4
See Also:
  • Field Details

    • currentRPM

      protected short currentRPM
      currentRPM is an undescribed parameter...
    • orderedRPM

      protected short orderedRPM
      orderedRPM is an undescribed parameter...
    • RPMrateOfChange

      protected int RPMrateOfChange
      RPMrateOfChange is an undescribed parameter...
  • Constructor Details

    • ShaftRPM

      public ShaftRPM()
      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:
    • setCurrentRPM

      public ShaftRPM setCurrentRPM(short pCurrentRPM)
      Setter for currentRPM
      Parameters:
      pCurrentRPM - new value of interest
      Returns:
      same object to permit progressive setters
    • setCurrentRPM

      public ShaftRPM setCurrentRPM(int pCurrentRPM)
      Utility setter for currentRPM
      Parameters:
      pCurrentRPM - new value of interest
      Returns:
      same object to permit progressive setters
    • getCurrentRPM

      public short getCurrentRPM()
      Getter for currentRPM
      Returns:
      value of interest
    • setOrderedRPM

      public ShaftRPM setOrderedRPM(short pOrderedRPM)
      Setter for orderedRPM
      Parameters:
      pOrderedRPM - new value of interest
      Returns:
      same object to permit progressive setters
    • setOrderedRPM

      public ShaftRPM setOrderedRPM(int pOrderedRPM)
      Utility setter for orderedRPM
      Parameters:
      pOrderedRPM - new value of interest
      Returns:
      same object to permit progressive setters
    • getOrderedRPM

      public short getOrderedRPM()
      Getter for orderedRPM
      Returns:
      value of interest
    • setRPMrateOfChange

      public ShaftRPM setRPMrateOfChange(int pRPMrateOfChange)
      Setter for RPMrateOfChange
      Parameters:
      pRPMrateOfChange - new value of interest
      Returns:
      same object to permit progressive setters
    • getRPMrateOfChange

      public int getRPMrateOfChange()
      Getter for RPMrateOfChange
      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