Class IsPartOfPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.EntityManagementFamilyPdu

edu.nps.moves.dis7.pdus.IsPartOfPdu

All Implemented Interfaces:

Marshaller, Serializable

public class IsPartOfPdu
extends EntityManagementFamilyPdu
implements Serializable

5.9.5 Used to request hierarchical linkage of separately hosted simulation entities

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
static final String	NAME	The name of this PDU type
protected NamedLocationIdentification	namedLocationID	named location
protected EntityID	orginatingEntityID	ID of entity originating PDU
protected EntityType	partEntityType	entity type
protected Vector3Float	partLocation	location of part; centroid of part in host's coordinate system. x=range, y=bearing, z=0
protected EntityID	receivingEntityID	ID of entity receiving PDU
protected Relationship	relationship	relationship of joined parts

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

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
IsPartOfPdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
IsPartOfPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
IsPartOfPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
IsPartOfPdu	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
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
NamedLocationIdentification	getNamedLocationID()	Getter for namedLocationID
EntityID	getOrginatingEntityID()	Getter for orginatingEntityID
EntityType	getPartEntityType()	Getter for partEntityType
Vector3Float	getPartLocation()	Getter for partLocation
EntityID	getReceivingEntityID()	Getter for receivingEntityID
Relationship	getRelationship()	Getter for relationship
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
IsPartOfPdu	setNamedLocationID(NamedLocationIdentification pNamedLocationID)	Setter for namedLocationID
IsPartOfPdu	setOrginatingEntityID(EntityID pOrginatingEntityID)	Setter for orginatingEntityID
IsPartOfPdu	setPartEntityType(EntityType pPartEntityType)	Setter for partEntityType
IsPartOfPdu	setPartLocation(Vector3Float pPartLocation)	Setter for partLocation
IsPartOfPdu	setReceivingEntityID(EntityID pReceivingEntityID)	Setter for receivingEntityID
IsPartOfPdu	setRelationship(Relationship pRelationship)	Setter for relationship
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

orginatingEntityID

protected EntityID orginatingEntityID

ID of entity originating PDU

receivingEntityID

protected EntityID receivingEntityID

ID of entity receiving PDU

relationship

protected Relationship relationship

relationship of joined parts

partLocation

protected Vector3Float partLocation

location of part; centroid of part in host's coordinate system. x=range, y=bearing, z=0

namedLocationID

protected NamedLocationIdentification namedLocationID

named location

partEntityType

protected EntityType partEntityType

entity type

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

IsPartOfPdu

public IsPartOfPdu()

Constructor creates and configures a new instance object

Method Details

copy

public IsPartOfPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public IsPartOfPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public IsPartOfPdu 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 EntityManagementFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setOrginatingEntityID

public IsPartOfPdu setOrginatingEntityID(EntityID pOrginatingEntityID)

Setter for orginatingEntityID

Parameters:

pOrginatingEntityID - new value of interest

Returns:

same object to permit progressive setters

getOrginatingEntityID

public EntityID getOrginatingEntityID()

Getter for orginatingEntityID

Returns:

value of interest

setReceivingEntityID

public IsPartOfPdu setReceivingEntityID(EntityID pReceivingEntityID)

Setter for receivingEntityID

Parameters:

pReceivingEntityID - new value of interest

Returns:

same object to permit progressive setters

getReceivingEntityID

public EntityID getReceivingEntityID()

Getter for receivingEntityID

Returns:

value of interest

setRelationship

public IsPartOfPdu setRelationship(Relationship pRelationship)

Setter for relationship

Parameters:

pRelationship - new value of interest

Returns:

same object to permit progressive setters

getRelationship

public Relationship getRelationship()

Getter for relationship

Returns:

value of interest

setPartLocation

public IsPartOfPdu setPartLocation(Vector3Float pPartLocation)

Setter for partLocation

Parameters:

pPartLocation - new value of interest

Returns:

same object to permit progressive setters

getPartLocation

public Vector3Float getPartLocation()

Getter for partLocation

Returns:

value of interest

setNamedLocationID

public IsPartOfPdu setNamedLocationID(NamedLocationIdentification pNamedLocationID)

Setter for namedLocationID

Parameters:

pNamedLocationID - new value of interest

Returns:

same object to permit progressive setters

getNamedLocationID

public NamedLocationIdentification getNamedLocationID()

Getter for namedLocationID

Returns:

value of interest

setPartEntityType

public IsPartOfPdu setPartEntityType(EntityType pPartEntityType)

Setter for partEntityType

Parameters:

pPartEntityType - new value of interest

Returns:

same object to permit progressive setters

getPartEntityType

public EntityType getPartEntityType()

Getter for partEntityType

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class EntityManagementFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase