Class LinearObjectStatePdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.SyntheticEnvironmentFamilyPdu

edu.nps.moves.dis7.pdus.LinearObjectStatePdu

All Implemented Interfaces:

Marshaller, Serializable

public class LinearObjectStatePdu
extends SyntheticEnvironmentFamilyPdu
implements Serializable

7.10.5 Used to communicate detailed information about the addition/modification of a synthetic environment object that is geometrically anchored to the terrain with one point and has size and orientation.

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 ForceID	forceID	force ID provides a unique identifier uid 6
protected List<LinearSegmentParameter>	linearSegmentParameters	Linear segment parameters
static final String	NAME	The name of this PDU type
protected byte	numberOfLinearSegments	number of linear segment parameters
protected ObjectIdentifier	objectID	Object in synthetic environment
protected ObjectType	objectType	Object type
protected SimulationAddress	receivingID	receiver ID provides a unique identifier
protected ObjectIdentifier	referencedObjectID	Object with which this point object is associated
protected SimulationAddress	requesterID	requesterID
protected short	updateNumber	unique update number of each state transition of an object

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

FAMILY_NAME

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

padding, pduStatus

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

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
LinearObjectStatePdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
LinearObjectStatePdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
LinearObjectStatePdu	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
ForceID	getForceID()	Getter for forceID
List<LinearSegmentParameter>	getLinearSegmentParameters()	Getter for linearSegmentParameters
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
ObjectIdentifier	getObjectID()	Getter for objectID
ObjectType	getObjectType()	Getter for objectType
SimulationAddress	getReceivingID()	Getter for receivingID
ObjectIdentifier	getReferencedObjectID()	Getter for referencedObjectID
SimulationAddress	getRequesterID()	Getter for requesterID
short	getUpdateNumber()	Getter for updateNumber
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
LinearObjectStatePdu	setForceID(ForceID pForceID)	Setter for forceID
LinearObjectStatePdu	setLinearSegmentParameters(List<LinearSegmentParameter> pLinearSegmentParameters)	Setter for linearSegmentParameters
LinearObjectStatePdu	setObjectID(ObjectIdentifier pObjectID)	Setter for objectID
LinearObjectStatePdu	setObjectType(ObjectType pObjectType)	Setter for objectType
LinearObjectStatePdu	setReceivingID(SimulationAddress pReceivingID)	Setter for receivingID
LinearObjectStatePdu	setReferencedObjectID(ObjectIdentifier pReferencedObjectID)	Setter for referencedObjectID
LinearObjectStatePdu	setRequesterID(SimulationAddress pRequesterID)	Setter for requesterID
LinearObjectStatePdu	setUpdateNumber(int pUpdateNumber)	Utility setter for updateNumber
LinearObjectStatePdu	setUpdateNumber(short pUpdateNumber)	Setter for updateNumber
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.PduBase

getPadding, getPduStatus, setPadding, setPadding, setPduStatus

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

objectID

protected ObjectIdentifier objectID

Object in synthetic environment

referencedObjectID

protected ObjectIdentifier referencedObjectID

Object with which this point object is associated

updateNumber

protected short updateNumber

unique update number of each state transition of an object

forceID

protected ForceID forceID

force ID provides a unique identifier uid 6

numberOfLinearSegments

protected byte numberOfLinearSegments

number of linear segment parameters

requesterID

protected SimulationAddress requesterID

requesterID

receivingID

protected SimulationAddress receivingID

receiver ID provides a unique identifier

objectType

protected ObjectType objectType

Object type

linearSegmentParameters

protected List<LinearSegmentParameter> linearSegmentParameters

Linear segment parameters

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

LinearObjectStatePdu

public LinearObjectStatePdu()

Constructor creates and configures a new instance object

Method Details

copy

public LinearObjectStatePdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public LinearObjectStatePdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public LinearObjectStatePdu 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 SyntheticEnvironmentFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setObjectID

public LinearObjectStatePdu setObjectID(ObjectIdentifier pObjectID)

Setter for objectID

Parameters:

pObjectID - new value of interest

Returns:

same object to permit progressive setters

getObjectID

public ObjectIdentifier getObjectID()

Getter for objectID

Returns:

value of interest

setReferencedObjectID

public LinearObjectStatePdu setReferencedObjectID(ObjectIdentifier pReferencedObjectID)

Setter for referencedObjectID

Parameters:

pReferencedObjectID - new value of interest

Returns:

same object to permit progressive setters

getReferencedObjectID

public ObjectIdentifier getReferencedObjectID()

Getter for referencedObjectID

Returns:

value of interest

setUpdateNumber

public LinearObjectStatePdu setUpdateNumber(short pUpdateNumber)

Setter for updateNumber

Parameters:

pUpdateNumber - new value of interest

Returns:

same object to permit progressive setters

setUpdateNumber

public LinearObjectStatePdu setUpdateNumber(int pUpdateNumber)

Utility setter for updateNumber

Parameters:

pUpdateNumber - new value of interest

Returns:

same object to permit progressive setters

getUpdateNumber

public short getUpdateNumber()

Getter for updateNumber

Returns:

value of interest

setForceID

public LinearObjectStatePdu setForceID(ForceID pForceID)

Setter for forceID

Parameters:

pForceID - new value of interest

Returns:

same object to permit progressive setters

getForceID

public ForceID getForceID()

Getter for forceID

Returns:

value of interest

setRequesterID

public LinearObjectStatePdu setRequesterID(SimulationAddress pRequesterID)

Setter for requesterID

Parameters:

pRequesterID - new value of interest

Returns:

same object to permit progressive setters

getRequesterID

public SimulationAddress getRequesterID()

Getter for requesterID

Returns:

value of interest

setReceivingID

public LinearObjectStatePdu setReceivingID(SimulationAddress pReceivingID)

Setter for receivingID

Parameters:

pReceivingID - new value of interest

Returns:

same object to permit progressive setters

getReceivingID

public SimulationAddress getReceivingID()

Getter for receivingID

Returns:

value of interest

setObjectType

public LinearObjectStatePdu setObjectType(ObjectType pObjectType)

Setter for objectType

Parameters:

pObjectType - new value of interest

Returns:

same object to permit progressive setters

getObjectType

public ObjectType getObjectType()

Getter for objectType

Returns:

value of interest

setLinearSegmentParameters

public LinearObjectStatePdu setLinearSegmentParameters(List<LinearSegmentParameter> pLinearSegmentParameters)

Setter for linearSegmentParameters

Parameters:

pLinearSegmentParameters - new value of interest

Returns:

same object to permit progressive setters

getLinearSegmentParameters

public List<LinearSegmentParameter> getLinearSegmentParameters()

Getter for linearSegmentParameters

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 SyntheticEnvironmentFamilyPdu

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 SyntheticEnvironmentFamilyPdu

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 SyntheticEnvironmentFamilyPdu

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 SyntheticEnvironmentFamilyPdu

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 SyntheticEnvironmentFamilyPdu

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 SyntheticEnvironmentFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class SyntheticEnvironmentFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase