Class CollisionPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.EntityInformationInteractionFamilyPdu

edu.nps.moves.dis7.pdus.CollisionPdu

All Implemented Interfaces:

Marshaller, Serializable

public class CollisionPdu
extends EntityInformationInteractionFamilyPdu
implements Serializable

7.2.3 Collisions between entities shall be communicated by issuing a Collision PDU. See 5.3.3.

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 EntityID	collidingEntityID	This field shall identify the entity that has collided with the issuing entity (see 5.3.3.4).
protected CollisionType	collisionType	This field shall identify the type of collision.
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected EventIdentifier	eventID	This field shall contain an identification generated by the issuing simulation application to associate related collision events.
protected EntityID	issuingEntityID	This field shall identify the entity that is issuing the PDU, and shall be represented by an Entity Identifier record (see 6.2.28).
protected Vector3Float	location	This field shall specify the location of the collision with respect to the entity with which the issuing entity collided.
protected float	mass	This field shall contain the mass of the issuing entity, and shall be represented by a 32-bit floating point number representing kilograms.
static final String	NAME	The name of this PDU type
protected byte	pad	some padding
protected Vector3Float	velocity	This field shall contain the velocity (at the time the collision is detected) of the issuing entity.

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

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

Method Summary

Modifier and Type	Method	Description
CollisionPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
CollisionPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
CollisionPdu	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
EntityID	getCollidingEntityID()	Getter for collidingEntityID
CollisionType	getCollisionType()	Getter for collisionType
EventIdentifier	getEventID()	Getter for eventID
EntityID	getIssuingEntityID()	Getter for issuingEntityID
Vector3Float	getLocation()	Getter for location
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
float	getMass()	Getter for mass
byte	getPad()	Getter for pad
Vector3Float	getVelocity()	Getter for velocity
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
CollisionPdu	setCollidingEntityID(EntityID pCollidingEntityID)	Setter for collidingEntityID
CollisionPdu	setCollisionType(CollisionType pCollisionType)	Setter for collisionType
CollisionPdu	setEventID(EventIdentifier pEventID)	Setter for eventID
CollisionPdu	setIssuingEntityID(EntityID pIssuingEntityID)	Setter for issuingEntityID
CollisionPdu	setLocation(Vector3Float pLocation)	Setter for location
CollisionPdu	setMass(float pMass)	Setter for mass
CollisionPdu	setPad(byte pPad)	Setter for pad
CollisionPdu	setPad(int pPad)	Utility setter for pad
CollisionPdu	setVelocity(Vector3Float pVelocity)	Setter for velocity
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

issuingEntityID

protected EntityID issuingEntityID

This field shall identify the entity that is issuing the PDU, and shall be represented by an Entity Identifier record (see 6.2.28).

collidingEntityID

protected EntityID collidingEntityID

This field shall identify the entity that has collided with the issuing entity (see 5.3.3.4). This field shall be represented by an Entity Identifier record (see 6.2.28).

eventID

protected EventIdentifier eventID

This field shall contain an identification generated by the issuing simulation application to associate related collision events. This field shall be represented by an Event Identifier record (see 6.2.34).

collisionType

protected CollisionType collisionType

This field shall identify the type of collision. The Collision Type field shall be represented by an 8-bit record of enumerations uid 189

pad

protected byte pad

some padding

velocity

protected Vector3Float velocity

This field shall contain the velocity (at the time the collision is detected) of the issuing entity. The velocity shall be represented in world coordinates. This field shall be represented by the Linear Velocity Vector record [see 6.2.95 item c)].

mass

protected float mass

This field shall contain the mass of the issuing entity, and shall be represented by a 32-bit floating point number representing kilograms.

location

protected Vector3Float location

This field shall specify the location of the collision with respect to the entity with which the issuing entity collided. The Location field shall be represented by an Entity Coordinate Vector record [see 6.2.95 item a)].

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

CollisionPdu

public CollisionPdu()

Constructor creates and configures a new instance object

Method Details

copy

public CollisionPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public CollisionPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public CollisionPdu 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 EntityInformationInteractionFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setIssuingEntityID

public CollisionPdu setIssuingEntityID(EntityID pIssuingEntityID)

Setter for issuingEntityID

Parameters:

pIssuingEntityID - new value of interest

Returns:

same object to permit progressive setters

getIssuingEntityID

public EntityID getIssuingEntityID()

Getter for issuingEntityID

Returns:

value of interest

setCollidingEntityID

public CollisionPdu setCollidingEntityID(EntityID pCollidingEntityID)

Setter for collidingEntityID

Parameters:

pCollidingEntityID - new value of interest

Returns:

same object to permit progressive setters

getCollidingEntityID

public EntityID getCollidingEntityID()

Getter for collidingEntityID

Returns:

value of interest

setEventID

public CollisionPdu setEventID(EventIdentifier pEventID)

Setter for eventID

Parameters:

pEventID - new value of interest

Returns:

same object to permit progressive setters

getEventID

public EventIdentifier getEventID()

Getter for eventID

Returns:

value of interest

setCollisionType

public CollisionPdu setCollisionType(CollisionType pCollisionType)

Setter for collisionType

Parameters:

pCollisionType - new value of interest

Returns:

same object to permit progressive setters

getCollisionType

public CollisionType getCollisionType()

Getter for collisionType

Returns:

value of interest

setPad

public CollisionPdu setPad(byte pPad)

Setter for pad

Parameters:

pPad - new value of interest

Returns:

same object to permit progressive setters

setPad

public CollisionPdu setPad(int pPad)

Utility setter for pad

Parameters:

pPad - new value of interest

Returns:

same object to permit progressive setters

getPad

public byte getPad()

Getter for pad

Returns:

value of interest

setVelocity

public CollisionPdu setVelocity(Vector3Float pVelocity)

Setter for velocity

Parameters:

pVelocity - new value of interest

Returns:

same object to permit progressive setters

getVelocity

public Vector3Float getVelocity()

Getter for velocity

Returns:

value of interest

setMass

public CollisionPdu setMass(float pMass)

Setter for mass

Parameters:

pMass - new value of interest

Returns:

same object to permit progressive setters

getMass

public float getMass()

Getter for mass

Returns:

value of interest

setLocation

public CollisionPdu setLocation(Vector3Float pLocation)

Setter for location

Parameters:

pLocation - new value of interest

Returns:

same object to permit progressive setters

getLocation

public Vector3Float getLocation()

Getter for location

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class EntityInformationInteractionFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase