Class UnderwaterAcousticPdu

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

All Implemented Interfaces:

Marshaller, Serializable

public class UnderwaterAcousticPdu
extends DistributedEmissionsRegenerationFamilyPdu
implements Serializable

7.6.4 Information about underwater acoustic emmissions. See 5.7.5.

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 List<APA>	apaData	additional passive activities
protected ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected List<UAEmitter>	emitterSystems	emitterSystems is an undescribed parameter...
protected EntityID	emittingEntityID	ID of the entity that is the source of the emission
protected EventIdentifier	eventID	ID of event
static final String	NAME	The name of this PDU type
protected byte	numberOfAPAs	This field shall indicate the number of APAs described in the current UA PDU
protected byte	numberOfShafts	This field shall represent the number of shafts on a platform
protected byte	numberOfUAEmitterSystems	This field shall specify the number of UA emitter systems being described in the current UA PDU
protected byte	pad	padding
protected UAPassiveParameterIndex	passiveParameterIndex	This field indicates which database record (or file) shall be used in the definition of passive signature (unintentional) emissions of the entity.
protected byte	propulsionPlantConfiguration	This field shall specify the entity propulsion plant configuration.
protected List<ShaftRPM>	shaftRPMs	shaft RPM values.
protected UAStateChangeUpdateIndicator	stateChangeIndicator	This field shall be used to indicate whether the data in the UA PDU represent a state update or data that have changed since issuance of the last UA PDU uid 143

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

Method Summary

Modifier and Type	Method	Description
UnderwaterAcousticPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
UnderwaterAcousticPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
UnderwaterAcousticPdu	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
List<APA>	getApaData()	Getter for apaData
List<UAEmitter>	getEmitterSystems()	Getter for emitterSystems
EntityID	getEmittingEntityID()	Getter for emittingEntityID
EventIdentifier	getEventID()	Getter for eventID
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
byte	getPad()	Getter for pad
UAPassiveParameterIndex	getPassiveParameterIndex()	Getter for passiveParameterIndex
byte	getPropulsionPlantConfiguration()	Getter for propulsionPlantConfiguration
List<ShaftRPM>	getShaftRPMs()	Getter for shaftRPMs
UAStateChangeUpdateIndicator	getStateChangeIndicator()	Getter for stateChangeIndicator
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
UnderwaterAcousticPdu	setApaData(List<APA> pApaData)	Setter for apaData
UnderwaterAcousticPdu	setEmitterSystems(List<UAEmitter> pEmitterSystems)	Setter for emitterSystems
UnderwaterAcousticPdu	setEmittingEntityID(EntityID pEmittingEntityID)	Setter for emittingEntityID
UnderwaterAcousticPdu	setEventID(EventIdentifier pEventID)	Setter for eventID
UnderwaterAcousticPdu	setPad(byte pPad)	Setter for pad
UnderwaterAcousticPdu	setPad(int pPad)	Utility setter for pad
UnderwaterAcousticPdu	setPassiveParameterIndex(UAPassiveParameterIndex pPassiveParameterIndex)	Setter for passiveParameterIndex
UnderwaterAcousticPdu	setPropulsionPlantConfiguration(byte pPropulsionPlantConfiguration)	Setter for propulsionPlantConfiguration
UnderwaterAcousticPdu	setPropulsionPlantConfiguration(int pPropulsionPlantConfiguration)	Utility setter for propulsionPlantConfiguration
UnderwaterAcousticPdu	setShaftRPMs(List<ShaftRPM> pShaftRPMs)	Setter for shaftRPMs
UnderwaterAcousticPdu	setStateChangeIndicator(UAStateChangeUpdateIndicator pStateChangeIndicator)	Setter for stateChangeIndicator
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

emittingEntityID

protected EntityID emittingEntityID

ID of the entity that is the source of the emission

eventID

protected EventIdentifier eventID

ID of event

stateChangeIndicator

protected UAStateChangeUpdateIndicator stateChangeIndicator

This field shall be used to indicate whether the data in the UA PDU represent a state update or data that have changed since issuance of the last UA PDU uid 143

pad

protected byte pad

padding

passiveParameterIndex

protected UAPassiveParameterIndex passiveParameterIndex

This field indicates which database record (or file) shall be used in the definition of passive signature (unintentional) emissions of the entity. The indicated database record (or file) shall define all noise generated as a function of propulsion plant configurations and associated auxiliaries. uid 148

propulsionPlantConfiguration

protected byte propulsionPlantConfiguration

This field shall specify the entity propulsion plant configuration. This field is used to determine the passive signature characteristics of an entity.

numberOfShafts

protected byte numberOfShafts

This field shall represent the number of shafts on a platform

numberOfAPAs

protected byte numberOfAPAs

This field shall indicate the number of APAs described in the current UA PDU

numberOfUAEmitterSystems

protected byte numberOfUAEmitterSystems

This field shall specify the number of UA emitter systems being described in the current UA PDU

shaftRPMs

protected List<ShaftRPM> shaftRPMs

shaft RPM values.

apaData

protected List<APA> apaData

additional passive activities

emitterSystems

protected List<UAEmitter> emitterSystems

emitterSystems is an undescribed parameter...

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

UnderwaterAcousticPdu

public UnderwaterAcousticPdu()

Constructor creates and configures a new instance object

Method Details

copy

public UnderwaterAcousticPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public UnderwaterAcousticPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public UnderwaterAcousticPdu 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)

setEmittingEntityID

public UnderwaterAcousticPdu setEmittingEntityID(EntityID pEmittingEntityID)

Setter for emittingEntityID

Parameters:

pEmittingEntityID - new value of interest

Returns:

same object to permit progressive setters

getEmittingEntityID

public EntityID getEmittingEntityID()

Getter for emittingEntityID

Returns:

value of interest

setEventID

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

setStateChangeIndicator

public UnderwaterAcousticPdu setStateChangeIndicator(UAStateChangeUpdateIndicator pStateChangeIndicator)

Setter for stateChangeIndicator

Parameters:

pStateChangeIndicator - new value of interest

Returns:

same object to permit progressive setters

getStateChangeIndicator

public UAStateChangeUpdateIndicator getStateChangeIndicator()

Getter for stateChangeIndicator

Returns:

value of interest

setPad

public UnderwaterAcousticPdu setPad(byte pPad)

Setter for pad

Parameters:

pPad - new value of interest

Returns:

same object to permit progressive setters

setPad

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

setPassiveParameterIndex

public UnderwaterAcousticPdu setPassiveParameterIndex(UAPassiveParameterIndex pPassiveParameterIndex)

Setter for passiveParameterIndex

Parameters:

pPassiveParameterIndex - new value of interest

Returns:

same object to permit progressive setters

getPassiveParameterIndex

public UAPassiveParameterIndex getPassiveParameterIndex()

Getter for passiveParameterIndex

Returns:

value of interest

setPropulsionPlantConfiguration

public UnderwaterAcousticPdu setPropulsionPlantConfiguration(byte pPropulsionPlantConfiguration)

Setter for propulsionPlantConfiguration

Parameters:

pPropulsionPlantConfiguration - new value of interest

Returns:

same object to permit progressive setters

setPropulsionPlantConfiguration

public UnderwaterAcousticPdu setPropulsionPlantConfiguration(int pPropulsionPlantConfiguration)

Utility setter for propulsionPlantConfiguration

Parameters:

pPropulsionPlantConfiguration - new value of interest

Returns:

same object to permit progressive setters

getPropulsionPlantConfiguration

public byte getPropulsionPlantConfiguration()

Getter for propulsionPlantConfiguration

Returns:

value of interest

setShaftRPMs

public UnderwaterAcousticPdu setShaftRPMs(List<ShaftRPM> pShaftRPMs)

Setter for shaftRPMs

Parameters:

pShaftRPMs - new value of interest

Returns:

same object to permit progressive setters

getShaftRPMs

public List<ShaftRPM> getShaftRPMs()

Getter for shaftRPMs

Returns:

value of interest

setApaData

public UnderwaterAcousticPdu setApaData(List<APA> pApaData)

Setter for apaData

Parameters:

pApaData - new value of interest

Returns:

same object to permit progressive setters

getApaData

public List<APA> getApaData()

Getter for apaData

Returns:

value of interest

setEmitterSystems

public UnderwaterAcousticPdu setEmitterSystems(List<UAEmitter> pEmitterSystems)

Setter for emitterSystems

Parameters:

pEmitterSystems - new value of interest

Returns:

same object to permit progressive setters

getEmitterSystems

public List<UAEmitter> getEmitterSystems()

Getter for emitterSystems

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