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.

See Also:

• IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation - Application Protocols
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected FuelLocation	fuelLocation	Location of fuel as related to entity.
protected FuelMeasurementUnits	fuelMeasurementUnits	Units in which the fuel is measured uid 328
protected int	fuelQuantity	Fuel quantity, units specified by next field
protected SupplyFuelType	fuelType	Type of fuel uid 413
protected byte	padding	zero-filled array of padding bits for byte alignment and consistent sizing of PDU data

Constructor Summary

Constructors

Constructor	Description
EngineFuel()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	equalsImpl(Object obj)	Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
FuelLocation	getFuelLocation()	Getter for fuelLocation
FuelMeasurementUnits	getFuelMeasurementUnits()	Getter for fuelMeasurementUnits
int	getFuelQuantity()	Getter for fuelQuantity
SupplyFuelType	getFuelType()	Getter for fuelType
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
byte	getPadding()	Getter for padding
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
EngineFuel	setFuelLocation(FuelLocation pFuelLocation)	Setter for fuelLocation
EngineFuel	setFuelMeasurementUnits(FuelMeasurementUnits pFuelMeasurementUnits)	Setter for fuelMeasurementUnits
EngineFuel	setFuelQuantity(int pFuelQuantity)	Setter for fuelQuantity
EngineFuel	setFuelType(SupplyFuelType pFuelType)	Setter for fuelType
EngineFuel	setPadding(byte pPadding)	Setter for padding
EngineFuel	setPadding(int pPadding)	Utility setter for padding
String	toString()
int	unmarshal(DataInputStream dis)	Deserializes an object from a DataInputStream.
int	unmarshal(ByteBuffer byteBuffer)	Unpacks a Pdu from the underlying data.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

zero-filled array of padding bits for byte alignment and consistent sizing of PDU data

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)

Setter for fuelMeasurementUnits

Parameters:

pFuelMeasurementUnits - new value of interest

Returns:

same object to permit progressive setters

getFuelMeasurementUnits

public FuelMeasurementUnits getFuelMeasurementUnits()

Getter for fuelMeasurementUnits

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object