Class PointObjectStatePdu

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.PointObjectStatePdu

All Implemented Interfaces:

Marshaller, Serializable

public class PointObjectStatePdu
extends SyntheticEnvironmentFamilyPdu
implements Serializable

7.10.4 Used to communicate detailed information about the addition/modification of a synthetic environment object that is geometrically anchored to the terrain with a single point.

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 ObjectStateAppearanceGeneral	generObjectAppearance	General object apperance uid 229
protected ObjectStateModificationPointObject	modifications	modifications uid 240
static final String	NAME	The name of this PDU type
protected EntityID	objectID	Object in synthetic environment
protected Vector3Double	objectLocation	Object location
protected EulerAngles	objectOrientation	Object orientation
protected ObjectType	objectType	Object type
protected int	pad2	padding
protected short	padding1	padding1 is an undescribed parameter...
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 int	specificObjectAppearance	Specific object apperance
protected int	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
PointObjectStatePdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
PointObjectStatePdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
PointObjectStatePdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
PointObjectStatePdu	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
ObjectStateAppearanceGeneral	getGenerObjectAppearance()	Getter for generObjectAppearance
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
ObjectStateModificationPointObject	getModifications()	Getter for modifications
EntityID	getObjectID()	Getter for objectID
Vector3Double	getObjectLocation()	Getter for objectLocation
EulerAngles	getObjectOrientation()	Getter for objectOrientation
ObjectType	getObjectType()	Getter for objectType
int	getPad2()	Getter for pad2
short	getPadding1()	Getter for padding1
SimulationAddress	getReceivingID()	Getter for receivingID
ObjectIdentifier	getReferencedObjectID()	Getter for referencedObjectID
SimulationAddress	getRequesterID()	Getter for requesterID
int	getSpecificObjectAppearance()	Getter for specificObjectAppearance
int	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.
PointObjectStatePdu	setForceID(ForceID pForceID)	Setter for forceID
PointObjectStatePdu	setGenerObjectAppearance(ObjectStateAppearanceGeneral pGenerObjectAppearance)	Setter for generObjectAppearance
PointObjectStatePdu	setModifications(ObjectStateModificationPointObject pModifications)	Setter for modifications
PointObjectStatePdu	setObjectID(EntityID pObjectID)	Setter for objectID
PointObjectStatePdu	setObjectLocation(Vector3Double pObjectLocation)	Setter for objectLocation
PointObjectStatePdu	setObjectOrientation(EulerAngles pObjectOrientation)	Setter for objectOrientation
PointObjectStatePdu	setObjectType(ObjectType pObjectType)	Setter for objectType
PointObjectStatePdu	setPad2(int pPad2)	Setter for pad2
PointObjectStatePdu	setPadding1(int pPadding1)	Utility setter for padding1
PointObjectStatePdu	setPadding1(short pPadding1)	Setter for padding1
PointObjectStatePdu	setReceivingID(SimulationAddress pReceivingID)	Setter for receivingID
PointObjectStatePdu	setReferencedObjectID(ObjectIdentifier pReferencedObjectID)	Setter for referencedObjectID
PointObjectStatePdu	setRequesterID(SimulationAddress pRequesterID)	Setter for requesterID
PointObjectStatePdu	setSpecificObjectAppearance(int pSpecificObjectAppearance)	Setter for specificObjectAppearance
PointObjectStatePdu	setUpdateNumber(int 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 EntityID objectID

Object in synthetic environment

referencedObjectID

protected ObjectIdentifier referencedObjectID

Object with which this point object is associated

updateNumber

protected int updateNumber

unique update number of each state transition of an object

forceID

protected ForceID forceID

force ID provides a unique identifier uid 6

modifications

protected ObjectStateModificationPointObject modifications

modifications uid 240

objectType

protected ObjectType objectType

Object type

objectLocation

protected Vector3Double objectLocation

Object location

objectOrientation

protected EulerAngles objectOrientation

Object orientation

specificObjectAppearance

protected int specificObjectAppearance

Specific object apperance

generObjectAppearance

protected ObjectStateAppearanceGeneral generObjectAppearance

General object apperance uid 229

padding1

protected short padding1

padding1 is an undescribed parameter...

requesterID

protected SimulationAddress requesterID

requesterID

receivingID

protected SimulationAddress receivingID

receiver ID provides a unique identifier

pad2

protected int pad2

padding

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

PointObjectStatePdu

public PointObjectStatePdu()

Constructor creates and configures a new instance object

Method Details

copy

public PointObjectStatePdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public PointObjectStatePdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public PointObjectStatePdu 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 PointObjectStatePdu setObjectID(EntityID pObjectID)

Setter for objectID

Parameters:

pObjectID - new value of interest

Returns:

same object to permit progressive setters

getObjectID

public EntityID getObjectID()

Getter for objectID

Returns:

value of interest

setReferencedObjectID

public PointObjectStatePdu 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 PointObjectStatePdu setUpdateNumber(int pUpdateNumber)

Setter for updateNumber

Parameters:

pUpdateNumber - new value of interest

Returns:

same object to permit progressive setters

getUpdateNumber

public int getUpdateNumber()

Getter for updateNumber

Returns:

value of interest

setForceID

public PointObjectStatePdu 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

setModifications

public PointObjectStatePdu setModifications(ObjectStateModificationPointObject pModifications)

Setter for modifications

Parameters:

pModifications - new value of interest

Returns:

same object to permit progressive setters

getModifications

public ObjectStateModificationPointObject getModifications()

Getter for modifications

Returns:

value of interest

setObjectType

public PointObjectStatePdu 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

setObjectLocation

public PointObjectStatePdu setObjectLocation(Vector3Double pObjectLocation)

Setter for objectLocation

Parameters:

pObjectLocation - new value of interest

Returns:

same object to permit progressive setters

getObjectLocation

public Vector3Double getObjectLocation()

Getter for objectLocation

Returns:

value of interest

setObjectOrientation

public PointObjectStatePdu setObjectOrientation(EulerAngles pObjectOrientation)

Setter for objectOrientation

Parameters:

pObjectOrientation - new value of interest

Returns:

same object to permit progressive setters

getObjectOrientation

public EulerAngles getObjectOrientation()

Getter for objectOrientation

Returns:

value of interest

setSpecificObjectAppearance

public PointObjectStatePdu setSpecificObjectAppearance(int pSpecificObjectAppearance)

Setter for specificObjectAppearance

Parameters:

pSpecificObjectAppearance - new value of interest

Returns:

same object to permit progressive setters

getSpecificObjectAppearance

public int getSpecificObjectAppearance()

Getter for specificObjectAppearance

Returns:

value of interest

setGenerObjectAppearance

public PointObjectStatePdu setGenerObjectAppearance(ObjectStateAppearanceGeneral pGenerObjectAppearance)

Setter for generObjectAppearance

Parameters:

pGenerObjectAppearance - new value of interest

Returns:

same object to permit progressive setters

getGenerObjectAppearance

public ObjectStateAppearanceGeneral getGenerObjectAppearance()

Getter for generObjectAppearance

Returns:

value of interest

setPadding1

public PointObjectStatePdu setPadding1(short pPadding1)

Setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

setPadding1

public PointObjectStatePdu setPadding1(int pPadding1)

Utility setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

getPadding1

public short getPadding1()

Getter for padding1

Returns:

value of interest

setRequesterID

public PointObjectStatePdu 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 PointObjectStatePdu 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

setPad2

public PointObjectStatePdu setPad2(int pPad2)

Setter for pad2

Parameters:

pPad2 - new value of interest

Returns:

same object to permit progressive setters

getPad2

public int getPad2()

Getter for pad2

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