Class SeparationVP

java.lang.Object

edu.nps.moves.dis7.pdus.SeparationVP

All Implemented Interfaces:

Serializable

public class SeparationVP
extends Object
implements Serializable

Physical separation of an entity from another entity. Section 6.2.94.6

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 byte	padding1	padding
protected short	padding2	padding
protected EntityID	parentEntityID	ID of parent
protected SeparationVPPreEntityIndicator	preEntityIndicator	Whether the entity existed prior to separation EBV uid 283
protected SeparationVPReasonforSeparation	reasonForSeparation	Reason for separation.
protected VariableParameterRecordType	recordType	The identification of the Variable Parameter record.
protected NamedLocationIdentification	stationLocation	Station separated from

Constructor Summary

Constructors

Constructor	Description
SeparationVP()	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
byte	getPadding1()	Getter for padding1
short	getPadding2()	Getter for padding2
EntityID	getParentEntityID()	Getter for parentEntityID
SeparationVPPreEntityIndicator	getPreEntityIndicator()	Getter for preEntityIndicator
SeparationVPReasonforSeparation	getReasonForSeparation()	Getter for reasonForSeparation
VariableParameterRecordType	getRecordType()	Getter for recordType
NamedLocationIdentification	getStationLocation()	Getter for stationLocation
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
SeparationVP	setPadding1(byte pPadding1)	Setter for padding1
SeparationVP	setPadding1(int pPadding1)	Utility setter for padding1
SeparationVP	setPadding2(int pPadding2)	Utility setter for padding2
SeparationVP	setPadding2(short pPadding2)	Setter for padding2
SeparationVP	setParentEntityID(EntityID pParentEntityID)	Setter for parentEntityID
SeparationVP	setPreEntityIndicator(SeparationVPPreEntityIndicator pPreEntityIndicator)	Setter for preEntityIndicator
SeparationVP	setReasonForSeparation(SeparationVPReasonforSeparation pReasonForSeparation)	Setter for reasonForSeparation
SeparationVP	setRecordType(VariableParameterRecordType pRecordType)	Setter for recordType
SeparationVP	setStationLocation(NamedLocationIdentification pStationLocation)	Setter for stationLocation
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

recordType

protected VariableParameterRecordType recordType

The identification of the Variable Parameter record. Enumeration from EBV uid 56

reasonForSeparation

protected SeparationVPReasonforSeparation reasonForSeparation

Reason for separation. EBV uid 282

preEntityIndicator

protected SeparationVPPreEntityIndicator preEntityIndicator

Whether the entity existed prior to separation EBV uid 283

padding1

protected byte padding1

padding

parentEntityID

protected EntityID parentEntityID

ID of parent

padding2

protected short padding2

padding

stationLocation

protected NamedLocationIdentification stationLocation

Station separated from

Constructor Details

SeparationVP

public SeparationVP()

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)

setRecordType

public SeparationVP setRecordType(VariableParameterRecordType pRecordType)

Setter for recordType

Parameters:

pRecordType - new value of interest

Returns:

same object to permit progressive setters

getRecordType

public VariableParameterRecordType getRecordType()

Getter for recordType

Returns:

value of interest

setReasonForSeparation

public SeparationVP setReasonForSeparation(SeparationVPReasonforSeparation pReasonForSeparation)

Setter for reasonForSeparation

Parameters:

pReasonForSeparation - new value of interest

Returns:

same object to permit progressive setters

getReasonForSeparation

public SeparationVPReasonforSeparation getReasonForSeparation()

Getter for reasonForSeparation

Returns:

value of interest

setPreEntityIndicator

public SeparationVP setPreEntityIndicator(SeparationVPPreEntityIndicator pPreEntityIndicator)

Setter for preEntityIndicator

Parameters:

pPreEntityIndicator - new value of interest

Returns:

same object to permit progressive setters

getPreEntityIndicator

public SeparationVPPreEntityIndicator getPreEntityIndicator()

Getter for preEntityIndicator

Returns:

value of interest

setPadding1

public SeparationVP setPadding1(byte pPadding1)

Setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

setPadding1

public SeparationVP setPadding1(int pPadding1)

Utility setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

getPadding1

public byte getPadding1()

Getter for padding1

Returns:

value of interest

setParentEntityID

public SeparationVP setParentEntityID(EntityID pParentEntityID)

Setter for parentEntityID

Parameters:

pParentEntityID - new value of interest

Returns:

same object to permit progressive setters

getParentEntityID

public EntityID getParentEntityID()

Getter for parentEntityID

Returns:

value of interest

setPadding2

public SeparationVP setPadding2(short pPadding2)

Setter for padding2

Parameters:

pPadding2 - new value of interest

Returns:

same object to permit progressive setters

setPadding2

public SeparationVP setPadding2(int pPadding2)

Utility setter for padding2

Parameters:

pPadding2 - new value of interest

Returns:

same object to permit progressive setters

getPadding2

public short getPadding2()

Getter for padding2

Returns:

value of interest

setStationLocation

public SeparationVP setStationLocation(NamedLocationIdentification pStationLocation)

Setter for stationLocation

Parameters:

pStationLocation - new value of interest

Returns:

same object to permit progressive setters

getStationLocation

public NamedLocationIdentification getStationLocation()

Getter for stationLocation

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