Class UABeam

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

public class UABeam extends Object implements Serializable
IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation - Application Protocols
See Also:
Serialized Form
  • Field Details

    • beamDataLength

      protected byte beamDataLength
      beamDataLength is an undescribed parameter...
    • beamNumber

      protected byte beamNumber
      beamNumber is an undescribed parameter...
    • padding

      protected short padding
      padding is an undescribed parameter...
    • fundamentalParameterData

      protected UAFundamentalParameter fundamentalParameterData
      fundamentalParameterData is an undescribed parameter...
  • Constructor Details

    • UABeam

      public UABeam()
      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:
      https://en.wikipedia.org/wiki/Marshalling_(computer_science)
    • setBeamDataLength

      public UABeam setBeamDataLength(byte pBeamDataLength)
      Setter for beamDataLength
      Parameters:
      pBeamDataLength - new value of interest
      Returns:
      same object to permit progressive setters
    • setBeamDataLength

      public UABeam setBeamDataLength(int pBeamDataLength)
      Utility setter for beamDataLength
      Parameters:
      pBeamDataLength - new value of interest
      Returns:
      same object to permit progressive setters
    • getBeamDataLength

      public byte getBeamDataLength()
      Getter for beamDataLength
      Returns:
      value of interest
    • setBeamNumber

      public UABeam setBeamNumber(byte pBeamNumber)
      Setter for beamNumber
      Parameters:
      pBeamNumber - new value of interest
      Returns:
      same object to permit progressive setters
    • setBeamNumber

      public UABeam setBeamNumber(int pBeamNumber)
      Utility setter for beamNumber
      Parameters:
      pBeamNumber - new value of interest
      Returns:
      same object to permit progressive setters
    • getBeamNumber

      public byte getBeamNumber()
      Getter for beamNumber
      Returns:
      value of interest
    • setPadding

      public UABeam setPadding(short pPadding)
      Setter for padding
      Parameters:
      pPadding - new value of interest
      Returns:
      same object to permit progressive setters
    • setPadding

      public UABeam setPadding(int pPadding)
      Utility setter for padding
      Parameters:
      pPadding - new value of interest
      Returns:
      same object to permit progressive setters
    • getPadding

      public short getPadding()
      Getter for padding
      Returns:
      value of interest
    • setFundamentalParameterData

      public UABeam setFundamentalParameterData(UAFundamentalParameter pFundamentalParameterData)
      Parameters:
      pFundamentalParameterData - new value of interest
      Returns:
      same object to permit progressive setters
    • getFundamentalParameterData

      public UAFundamentalParameter getFundamentalParameterData()
      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:
      DataOutputStream
    • 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:
      DataInputStream, https://en.wikipedia.org/wiki/Marshalling_(computer_science)
    • 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:
      ByteBuffer
    • 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:
      ByteBuffer, https://en.wikipedia.org/wiki/Marshalling_(computer_science)
    • 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