Class TSPIPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.LiveEntityFamilyPdu

edu.nps.moves.dis7.pdus.TSPIPdu

All Implemented Interfaces:

Marshaller, Serializable

Direct Known Subclasses:

TimeSpacePositionInformationPdu

public class TSPIPdu
extends LiveEntityFamilyPdu
implements Serializable

9.4.2 The Time Space Position Information (TSPI) PDU shall communicate information about the LE’s state vector.

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 ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected LiveDeadReckoningParameters	deadReckoningParameters	deadReckoningParameters is an undescribed parameter...
protected LiveEntityLinearVelocity	entityLinearVelocity	entityLinearVelocity is an undescribed parameter...
protected LiveEntityRelativeWorldCoordinates	entityLocation	entityLocation is an undescribed parameter...
protected LiveEntityOrientation	entityOrientation	entityOrientation is an undescribed parameter...
protected EntityID	liveEntityId	liveEntityId is an undescribed parameter...
protected short	measuredSpeed	measuredSpeed is an undescribed parameter...
static final String	NAME	The name of this PDU type
protected LiveEntityOrientationError	orientationError	orientationError is an undescribed parameter...
protected LiveEntityPositionError	positionError	positionError is an undescribed parameter...
protected byte[]	systemSpecificData	systemSpecificData is an undescribed parameter...
protected byte	systemSpecificDataLength	systemSpecificDataLength is an undescribed parameter...
protected byte	TSPIFlag	bit field

Fields inherited from class edu.nps.moves.dis7.pdus.LiveEntityFamilyPdu

FAMILY_NAME

Fields inherited from class edu.nps.moves.dis7.pdus.Pdu

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TSPIPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
TSPIPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
TSPIPdu	copyDataOutputStream()	copy method creates a deep copy of current object using DataOutputStream methods.
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
LiveDeadReckoningParameters	getDeadReckoningParameters()	Getter for deadReckoningParameters
LiveEntityLinearVelocity	getEntityLinearVelocity()	Getter for entityLinearVelocity
LiveEntityRelativeWorldCoordinates	getEntityLocation()	Getter for entityLocation
LiveEntityOrientation	getEntityOrientation()	Getter for entityOrientation
EntityID	getLiveEntityId()	Getter for liveEntityId
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
short	getMeasuredSpeed()	Getter for measuredSpeed
LiveEntityOrientationError	getOrientationError()	Getter for orientationError
LiveEntityPositionError	getPositionError()	Getter for positionError
byte[]	getSystemSpecificData()	Getter for systemSpecificData
byte	getTSPIFlag()	Getter for TSPIFlag
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
TSPIPdu	setDeadReckoningParameters(LiveDeadReckoningParameters pDeadReckoningParameters)	Setter for deadReckoningParameters
TSPIPdu	setEntityLinearVelocity(LiveEntityLinearVelocity pEntityLinearVelocity)	Setter for entityLinearVelocity
TSPIPdu	setEntityLocation(LiveEntityRelativeWorldCoordinates pEntityLocation)	Setter for entityLocation
TSPIPdu	setEntityOrientation(LiveEntityOrientation pEntityOrientation)	Setter for entityOrientation
TSPIPdu	setLiveEntityId(EntityID pLiveEntityId)	Setter for liveEntityId
TSPIPdu	setMeasuredSpeed(int pMeasuredSpeed)	Utility setter for measuredSpeed
TSPIPdu	setMeasuredSpeed(short pMeasuredSpeed)	Setter for measuredSpeed
TSPIPdu	setOrientationError(LiveEntityOrientationError pOrientationError)	Setter for orientationError
TSPIPdu	setPositionError(LiveEntityPositionError pPositionError)	Setter for positionError
TSPIPdu	setSystemSpecificData(byte[] pSystemSpecificData)	Setter for systemSpecificData
TSPIPdu	setTSPIFlag(byte pTSPIFlag)	Setter for TSPIFlag
TSPIPdu	setTSPIFlag(int pTSPIFlag)	Utility setter for TSPIFlag
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 edu.nps.moves.dis7.pdus.Pdu

copyByPduFactory, getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, getTimestampSeconds, isAcknowledgeRPdu, isActionRequestPdu, isActionRequestRPdu, isActionResponsePdu, isActionResponseRPdu, isAggregateStatePdu, isAppearancePdu, isArealObjectStatePdu, isArticulatedPartsPdu, isAttributePdu, isCollisionElasticPdu, isCollisionPdu, isCommentPdu, isCommentRPdu, isCreateEntityPdu, isCreateEntityRPdu, isDataPdu, isDataQueryPdu, isDataQueryRPdu, isDataRPdu, isDesignatorPdu, isDetonationPdu, isDirectedEnergyFirePdu, isDistributedEmissionsRegenerationFamilyPdu, isElectromagneticEmissionPdu, isEntityDamageStatusPdu, isEntityInformationInteractionFamilyPdu, isEntityManagementFamilyPdu, isEntityStatePdu, isEntityStateUpdatePdu, isEnvironmentalProcessPdu, isEventReportPdu, isEventReportRPdu, isFirePdu, isGriddedDataPdu, isIFFPdu, isInformationOperationsActionPdu, isInformationOperationsFamilyPdu, isInformationOperationsReportPdu, isIntercomControlPdu, isIntercomSignalPdu, isIsGroupOfPdu, isIsPartOfPdu, isLEDetonationPdu, isLEFirePdu, isLinearObjectStatePdu, isLiveEntityDetonationPdu, isLiveEntityFirePdu, isLogisticsFamilyPdu, isMinefieldDataPdu, isMinefieldFamilyPdu, isMinefieldQueryPdu, isMinefieldResponseNACKPdu, isMinefieldStatePdu, isPointObjectStatePdu, isRadioCommunicationsFamilyPdu, isReceiverPdu, isRecordQueryRPdu, isRecordRPdu, isReliablePdu, isRemoveEntityPdu, isRemoveEntityRPdu, isRepairCompletePdu, isRepairResponsePdu, isResupplyCancelPdu, isResupplyOfferPdu, isResupplyReceivedPdu, isSEESPdu, isSetDataPdu, isSetDataRPdu, isSetRecordRPdu, isSignalPdu, isSimulationManagementFamilyPdu, isSimulationManagementWithReliabilityFamilyPdu, isStartResumePdu, isStartResumeRPdu, isStopFreezePdu, isStopFreezeRPdu, isSupplementalEmissionEntityStatePdu, isSyntheticEnvironmentFamilyPdu, isTransferOwnershipPdu, isTransmitterPdu, isTSPIPdu, isUnderwaterAcousticPdu, isWarfareFamilyPdu, marshal, occursAfter, occursBefore, occursSameTime, setExerciseID, setExerciseID, setLength, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp, setTimestampSeconds

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

The name of this PDU type

See Also:

• Constant Field Values

liveEntityId

protected EntityID liveEntityId

liveEntityId is an undescribed parameter...

TSPIFlag

protected byte TSPIFlag

bit field

entityLocation

protected LiveEntityRelativeWorldCoordinates entityLocation

entityLocation is an undescribed parameter...

entityLinearVelocity

protected LiveEntityLinearVelocity entityLinearVelocity

entityLinearVelocity is an undescribed parameter...

entityOrientation

protected LiveEntityOrientation entityOrientation

entityOrientation is an undescribed parameter...

positionError

protected LiveEntityPositionError positionError

positionError is an undescribed parameter...

orientationError

protected LiveEntityOrientationError orientationError

orientationError is an undescribed parameter...

deadReckoningParameters

protected LiveDeadReckoningParameters deadReckoningParameters

deadReckoningParameters is an undescribed parameter...

measuredSpeed

protected short measuredSpeed

measuredSpeed is an undescribed parameter...

systemSpecificDataLength

protected byte systemSpecificDataLength

systemSpecificDataLength is an undescribed parameter...

systemSpecificData

protected byte[] systemSpecificData

systemSpecificData is an undescribed parameter...

byteArrayOutputStream

protected ByteArrayOutputStream byteArrayOutputStream

byteArrayOutputStream (baos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

dataOutputStream

protected DataOutputStream dataOutputStream

dataOutputStream (dos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

Constructor Details

TSPIPdu

public TSPIPdu()

Constructor creates and configures a new instance object

Method Details

copy

public TSPIPdu copy()

copy method creates a deep copy of current object using preferred marshalling method

Returns:

deep copy of PDU

copyByteBuffer

public TSPIPdu copyByteBuffer()

Creates a "deep copy" of current object using ByteBuffer methods.

Returns:

deep copy of PDU

copyDataOutputStream

public TSPIPdu copyDataOutputStream()

copy method creates a deep copy of current object using DataOutputStream methods.

Returns:

deep copy of PDU

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Specified by:

getMarshalledSize in interface Marshaller

Overrides:

getMarshalledSize in class LiveEntityFamilyPdu

Returns:

serialized size in bytes

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

setLiveEntityId

public TSPIPdu setLiveEntityId(EntityID pLiveEntityId)

Setter for liveEntityId

Parameters:

pLiveEntityId - new value of interest

Returns:

same object to permit progressive setters

getLiveEntityId

public EntityID getLiveEntityId()

Getter for liveEntityId

Returns:

value of interest

setTSPIFlag

public TSPIPdu setTSPIFlag(byte pTSPIFlag)

Setter for TSPIFlag

Parameters:

pTSPIFlag - new value of interest

Returns:

same object to permit progressive setters

setTSPIFlag

public TSPIPdu setTSPIFlag(int pTSPIFlag)

Utility setter for TSPIFlag

Parameters:

pTSPIFlag - new value of interest

Returns:

same object to permit progressive setters

getTSPIFlag

public byte getTSPIFlag()

Getter for TSPIFlag

Returns:

value of interest

setEntityLocation

public TSPIPdu setEntityLocation(LiveEntityRelativeWorldCoordinates pEntityLocation)

Setter for entityLocation

Parameters:

pEntityLocation - new value of interest

Returns:

same object to permit progressive setters

getEntityLocation

public LiveEntityRelativeWorldCoordinates getEntityLocation()

Getter for entityLocation

Returns:

value of interest

setEntityLinearVelocity

public TSPIPdu setEntityLinearVelocity(LiveEntityLinearVelocity pEntityLinearVelocity)

Setter for entityLinearVelocity

Parameters:

pEntityLinearVelocity - new value of interest

Returns:

same object to permit progressive setters

getEntityLinearVelocity

public LiveEntityLinearVelocity getEntityLinearVelocity()

Getter for entityLinearVelocity

Returns:

value of interest

setEntityOrientation

public TSPIPdu setEntityOrientation(LiveEntityOrientation pEntityOrientation)

Setter for entityOrientation

Parameters:

pEntityOrientation - new value of interest

Returns:

same object to permit progressive setters

getEntityOrientation

public LiveEntityOrientation getEntityOrientation()

Getter for entityOrientation

Returns:

value of interest

setPositionError

public TSPIPdu setPositionError(LiveEntityPositionError pPositionError)

Setter for positionError

Parameters:

pPositionError - new value of interest

Returns:

same object to permit progressive setters

getPositionError

public LiveEntityPositionError getPositionError()

Getter for positionError

Returns:

value of interest

setOrientationError

public TSPIPdu setOrientationError(LiveEntityOrientationError pOrientationError)

Setter for orientationError

Parameters:

pOrientationError - new value of interest

Returns:

same object to permit progressive setters

getOrientationError

public LiveEntityOrientationError getOrientationError()

Getter for orientationError

Returns:

value of interest

setDeadReckoningParameters

public TSPIPdu setDeadReckoningParameters(LiveDeadReckoningParameters pDeadReckoningParameters)

Setter for deadReckoningParameters

Parameters:

pDeadReckoningParameters - new value of interest

Returns:

same object to permit progressive setters

getDeadReckoningParameters

public LiveDeadReckoningParameters getDeadReckoningParameters()

Getter for deadReckoningParameters

Returns:

value of interest

setMeasuredSpeed

public TSPIPdu setMeasuredSpeed(short pMeasuredSpeed)

Setter for measuredSpeed

Parameters:

pMeasuredSpeed - new value of interest

Returns:

same object to permit progressive setters

setMeasuredSpeed

public TSPIPdu setMeasuredSpeed(int pMeasuredSpeed)

Utility setter for measuredSpeed

Parameters:

pMeasuredSpeed - new value of interest

Returns:

same object to permit progressive setters

getMeasuredSpeed

public short getMeasuredSpeed()

Getter for measuredSpeed

Returns:

value of interest

setSystemSpecificData

public TSPIPdu setSystemSpecificData(byte[] pSystemSpecificData)

Setter for systemSpecificData

Parameters:

pSystemSpecificData - new value of interest

Returns:

same object to permit progressive setters

getSystemSpecificData

public byte[] getSystemSpecificData()

Getter for systemSpecificData

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class LiveEntityFamilyPdu

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.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class LiveEntityFamilyPdu

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.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class LiveEntityFamilyPdu

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.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

equalsImpl

public boolean equalsImpl(Object obj)

Description copied from class: Pdu

Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object

Overrides:

equalsImpl in class LiveEntityFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class LiveEntityFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class Pdu