Class EngineFuel

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

public class EngineFuel extends Object implements Serializable
Information about an entity's engine fuel. Section 6.2.24. IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation - Application Protocols
See Also:
Serialized Form
  • Field Details

    • fuelQuantity

      protected int fuelQuantity
      Fuel quantity, units specified by next field
    • fuelMeasurementUnits

      protected FuelMeasurementUnits fuelMeasurementUnits
      Units in which the fuel is measured uid 328
    • fuelType

      protected SupplyFuelType fuelType
      Type of fuel uid 413
    • fuelLocation

      protected FuelLocation fuelLocation
      Location of fuel as related to entity. See section 14 of EBV document uid 329
    • padding

      protected byte padding
      padding
  • Constructor Details

    • EngineFuel

      public EngineFuel()
      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)
    • setFuelQuantity

      public EngineFuel setFuelQuantity(int pFuelQuantity)
      Setter for fuelQuantity
      Parameters:
      pFuelQuantity - new value of interest
      Returns:
      same object to permit progressive setters
    • getFuelQuantity

      public int getFuelQuantity()
      Getter for fuelQuantity
      Returns:
      value of interest
    • setFuelMeasurementUnits

      public EngineFuel setFuelMeasurementUnits(FuelMeasurementUnits pFuelMeasurementUnits)
      Parameters:
      pFuelMeasurementUnits - new value of interest
      Returns:
      same object to permit progressive setters
    • getFuelMeasurementUnits

      public FuelMeasurementUnits getFuelMeasurementUnits()
      Returns:
      value of interest
    • setFuelType

      public EngineFuel setFuelType(SupplyFuelType pFuelType)
      Setter for fuelType
      Parameters:
      pFuelType - new value of interest
      Returns:
      same object to permit progressive setters
    • getFuelType

      public SupplyFuelType getFuelType()
      Getter for fuelType
      Returns:
      value of interest
    • setFuelLocation

      public EngineFuel setFuelLocation(FuelLocation pFuelLocation)
      Setter for fuelLocation
      Parameters:
      pFuelLocation - new value of interest
      Returns:
      same object to permit progressive setters
    • getFuelLocation

      public FuelLocation getFuelLocation()
      Getter for fuelLocation
      Returns:
      value of interest
    • setPadding

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

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

      public byte getPadding()
      Getter for padding
      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