Class DesignatorPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.DistributedEmissionsRegenerationFamilyPdu

edu.nps.moves.dis7.pdus.DesignatorPdu

All Implemented Interfaces:

Marshaller, Serializable

public class DesignatorPdu
extends DistributedEmissionsRegenerationFamilyPdu
implements Serializable

7.6.3 Handles designating operations. See 5.3.7.2.

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 DesignatorSystemName	codeName	This field shall specify a unique emitter database number assigned to differentiate between otherwise similar or identical emitter beams within an emitter system. uid 80
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected DeadReckoningAlgorithm	deadReckoningAlgorithm	Dead reckoning algorithm uid 44
protected EntityID	designatedEntityID	ID of the entity being designated
protected EntityID	designatingEntityID	ID of the entity designating
protected DesignatorDesignatorCode	designatorCode	This field shall identify the designator code being used by the designating entity uid 81
protected float	designatorPower	This field shall identify the designator output power in watts
protected Vector3Double	designatorSpotLocation	designtor spot wrt the designated entity
protected Vector3Float	designatorSpotWrtDesignated	designtor spot wrt the designated entity
protected float	designatorWavelength	This field shall identify the designator wavelength in units of microns
protected Vector3Float	entityLinearAcceleration	linear accelleration of entity
static final String	NAME	The name of this PDU type
protected byte	padding1	padding
protected short	padding2	padding

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

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

Method Summary

Modifier and Type	Method	Description
DesignatorPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
DesignatorPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
DesignatorPdu	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
DesignatorSystemName	getCodeName()	Getter for codeName
DeadReckoningAlgorithm	getDeadReckoningAlgorithm()	Getter for deadReckoningAlgorithm
EntityID	getDesignatedEntityID()	Getter for designatedEntityID
EntityID	getDesignatingEntityID()	Getter for designatingEntityID
DesignatorDesignatorCode	getDesignatorCode()	Getter for designatorCode
float	getDesignatorPower()	Getter for designatorPower
Vector3Double	getDesignatorSpotLocation()	Getter for designatorSpotLocation
Vector3Float	getDesignatorSpotWrtDesignated()	Getter for designatorSpotWrtDesignated
float	getDesignatorWavelength()	Getter for designatorWavelength
Vector3Float	getEntityLinearAcceleration()	Getter for entityLinearAcceleration
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
byte	getPadding1()	Getter for padding1
short	getPadding2()	Getter for padding2
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
DesignatorPdu	setCodeName(DesignatorSystemName pCodeName)	Setter for codeName
DesignatorPdu	setDeadReckoningAlgorithm(DeadReckoningAlgorithm pDeadReckoningAlgorithm)	Setter for deadReckoningAlgorithm
DesignatorPdu	setDesignatedEntityID(EntityID pDesignatedEntityID)	Setter for designatedEntityID
DesignatorPdu	setDesignatingEntityID(EntityID pDesignatingEntityID)	Setter for designatingEntityID
DesignatorPdu	setDesignatorCode(DesignatorDesignatorCode pDesignatorCode)	Setter for designatorCode
DesignatorPdu	setDesignatorPower(float pDesignatorPower)	Setter for designatorPower
DesignatorPdu	setDesignatorSpotLocation(Vector3Double pDesignatorSpotLocation)	Setter for designatorSpotLocation
DesignatorPdu	setDesignatorSpotWrtDesignated(Vector3Float pDesignatorSpotWrtDesignated)	Setter for designatorSpotWrtDesignated
DesignatorPdu	setDesignatorWavelength(float pDesignatorWavelength)	Setter for designatorWavelength
DesignatorPdu	setEntityLinearAcceleration(Vector3Float pEntityLinearAcceleration)	Setter for entityLinearAcceleration
DesignatorPdu	setPadding1(byte pPadding1)	Setter for padding1
DesignatorPdu	setPadding1(int pPadding1)	Utility setter for padding1
DesignatorPdu	setPadding2(int pPadding2)	Utility setter for padding2
DesignatorPdu	setPadding2(short pPadding2)	Setter for padding2
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

designatingEntityID

protected EntityID designatingEntityID

ID of the entity designating

codeName

protected DesignatorSystemName codeName

This field shall specify a unique emitter database number assigned to differentiate between otherwise similar or identical emitter beams within an emitter system. uid 80

designatedEntityID

protected EntityID designatedEntityID

ID of the entity being designated

designatorCode

protected DesignatorDesignatorCode designatorCode

This field shall identify the designator code being used by the designating entity uid 81

designatorPower

protected float designatorPower

This field shall identify the designator output power in watts

designatorWavelength

protected float designatorWavelength

This field shall identify the designator wavelength in units of microns

designatorSpotWrtDesignated

protected Vector3Float designatorSpotWrtDesignated

designtor spot wrt the designated entity

designatorSpotLocation

protected Vector3Double designatorSpotLocation

designtor spot wrt the designated entity

deadReckoningAlgorithm

protected DeadReckoningAlgorithm deadReckoningAlgorithm

Dead reckoning algorithm uid 44

padding1

protected byte padding1

padding

padding2

protected short padding2

padding

entityLinearAcceleration

protected Vector3Float entityLinearAcceleration

linear accelleration of entity

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

DesignatorPdu

public DesignatorPdu()

Constructor creates and configures a new instance object

Method Details

copy

public DesignatorPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public DesignatorPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public DesignatorPdu 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 DistributedEmissionsRegenerationFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setDesignatingEntityID

public DesignatorPdu setDesignatingEntityID(EntityID pDesignatingEntityID)

Setter for designatingEntityID

Parameters:

pDesignatingEntityID - new value of interest

Returns:

same object to permit progressive setters

getDesignatingEntityID

public EntityID getDesignatingEntityID()

Getter for designatingEntityID

Returns:

value of interest

setCodeName

public DesignatorPdu setCodeName(DesignatorSystemName pCodeName)

Setter for codeName

Parameters:

pCodeName - new value of interest

Returns:

same object to permit progressive setters

getCodeName

public DesignatorSystemName getCodeName()

Getter for codeName

Returns:

value of interest

setDesignatedEntityID

public DesignatorPdu setDesignatedEntityID(EntityID pDesignatedEntityID)

Setter for designatedEntityID

Parameters:

pDesignatedEntityID - new value of interest

Returns:

same object to permit progressive setters

getDesignatedEntityID

public EntityID getDesignatedEntityID()

Getter for designatedEntityID

Returns:

value of interest

setDesignatorCode

public DesignatorPdu setDesignatorCode(DesignatorDesignatorCode pDesignatorCode)

Setter for designatorCode

Parameters:

pDesignatorCode - new value of interest

Returns:

same object to permit progressive setters

getDesignatorCode

public DesignatorDesignatorCode getDesignatorCode()

Getter for designatorCode

Returns:

value of interest

setDesignatorPower

public DesignatorPdu setDesignatorPower(float pDesignatorPower)

Setter for designatorPower

Parameters:

pDesignatorPower - new value of interest

Returns:

same object to permit progressive setters

getDesignatorPower

public float getDesignatorPower()

Getter for designatorPower

Returns:

value of interest

setDesignatorWavelength

public DesignatorPdu setDesignatorWavelength(float pDesignatorWavelength)

Setter for designatorWavelength

Parameters:

pDesignatorWavelength - new value of interest

Returns:

same object to permit progressive setters

getDesignatorWavelength

public float getDesignatorWavelength()

Getter for designatorWavelength

Returns:

value of interest

setDesignatorSpotWrtDesignated

public DesignatorPdu setDesignatorSpotWrtDesignated(Vector3Float pDesignatorSpotWrtDesignated)

Setter for designatorSpotWrtDesignated

Parameters:

pDesignatorSpotWrtDesignated - new value of interest

Returns:

same object to permit progressive setters

getDesignatorSpotWrtDesignated

public Vector3Float getDesignatorSpotWrtDesignated()

Getter for designatorSpotWrtDesignated

Returns:

value of interest

setDesignatorSpotLocation

public DesignatorPdu setDesignatorSpotLocation(Vector3Double pDesignatorSpotLocation)

Setter for designatorSpotLocation

Parameters:

pDesignatorSpotLocation - new value of interest

Returns:

same object to permit progressive setters

getDesignatorSpotLocation

public Vector3Double getDesignatorSpotLocation()

Getter for designatorSpotLocation

Returns:

value of interest

setDeadReckoningAlgorithm

public DesignatorPdu setDeadReckoningAlgorithm(DeadReckoningAlgorithm pDeadReckoningAlgorithm)

Setter for deadReckoningAlgorithm

Parameters:

pDeadReckoningAlgorithm - new value of interest

Returns:

same object to permit progressive setters

getDeadReckoningAlgorithm

public DeadReckoningAlgorithm getDeadReckoningAlgorithm()

Getter for deadReckoningAlgorithm

Returns:

value of interest

setPadding1

public DesignatorPdu setPadding1(byte pPadding1)

Setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

setPadding1

public DesignatorPdu setPadding1(int pPadding1)

Utility setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

getPadding1

public byte getPadding1()

Getter for padding1

Returns:

value of interest

setPadding2

public DesignatorPdu setPadding2(short pPadding2)

Setter for padding2

Parameters:

pPadding2 - new value of interest

Returns:

same object to permit progressive setters

setPadding2

public DesignatorPdu setPadding2(int pPadding2)

Utility setter for padding2

Parameters:

pPadding2 - new value of interest

Returns:

same object to permit progressive setters

getPadding2

public short getPadding2()

Getter for padding2

Returns:

value of interest

setEntityLinearAcceleration

public DesignatorPdu setEntityLinearAcceleration(Vector3Float pEntityLinearAcceleration)

Setter for entityLinearAcceleration

Parameters:

pEntityLinearAcceleration - new value of interest

Returns:

same object to permit progressive setters

getEntityLinearAcceleration

public Vector3Float getEntityLinearAcceleration()

Getter for entityLinearAcceleration

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 DistributedEmissionsRegenerationFamilyPdu

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 DistributedEmissionsRegenerationFamilyPdu

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 DistributedEmissionsRegenerationFamilyPdu

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 DistributedEmissionsRegenerationFamilyPdu

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 DistributedEmissionsRegenerationFamilyPdu

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 DistributedEmissionsRegenerationFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class DistributedEmissionsRegenerationFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase