Class NamedLocationIdentification

java.lang.Object

edu.nps.moves.dis7.pdus.NamedLocationIdentification

All Implemented Interfaces:

Serializable

public class NamedLocationIdentification
extends Object
implements Serializable

Information about the discrete positional relationship of the part entity with respect to the its host entity Section 6.2.62

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 IsPartOfStationName	stationName	The station name within the host at which the part entity is located.
protected short	stationNumber	The number of the particular wing station, cargo hold etc., at which the part is attached.

Constructor Summary

Constructors

Constructor	Description
NamedLocationIdentification()	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
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
IsPartOfStationName	getStationName()	Getter for stationName
short	getStationNumber()	Getter for stationNumber
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
NamedLocationIdentification	setStationName(IsPartOfStationName pStationName)	Setter for stationName
NamedLocationIdentification	setStationNumber(int pStationNumber)	Utility setter for stationNumber
NamedLocationIdentification	setStationNumber(short pStationNumber)	Setter for stationNumber
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

stationName

protected IsPartOfStationName stationName

The station name within the host at which the part entity is located. If the part entity is On Station, this field shall specify the representation of the part's location data fields. This field shall be specified by a 16-bit enumeration uid 212

stationNumber

protected short stationNumber

The number of the particular wing station, cargo hold etc., at which the part is attached.

Constructor Details

NamedLocationIdentification

public NamedLocationIdentification()

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)

setStationName

public NamedLocationIdentification setStationName(IsPartOfStationName pStationName)

Setter for stationName

Parameters:

pStationName - new value of interest

Returns:

same object to permit progressive setters

getStationName

public IsPartOfStationName getStationName()

Getter for stationName

Returns:

value of interest

setStationNumber

public NamedLocationIdentification setStationNumber(short pStationNumber)

Setter for stationNumber

Parameters:

pStationNumber - new value of interest

Returns:

same object to permit progressive setters

setStationNumber

public NamedLocationIdentification setStationNumber(int pStationNumber)

Utility setter for stationNumber

Parameters:

pStationNumber - new value of interest

Returns:

same object to permit progressive setters

getStationNumber

public short getStationNumber()

Getter for stationNumber

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