Package edu.nps.moves.dis7
Class UnderwaterAcousticPdu
java.lang.Object
edu.nps.moves.dis7.Pdu
edu.nps.moves.dis7.PduBase
edu.nps.moves.dis7.DistributedEmissionsFamilyPdu
edu.nps.moves.dis7.UnderwaterAcousticPdu
- All Implemented Interfaces:
edu.nps.moves.dis7.Marshaller,java.io.Serializable
public class UnderwaterAcousticPdu extends DistributedEmissionsFamilyPdu implements java.io.Serializable
7.6.4 Information about underwater acoustic emmissions. See 5.7.5.
IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation—Application Protocols
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description protected java.util.List<APA>apaDataadditional passive activitiesprotected java.util.List<UAEmitter>emitterSystemsprotected EntityIDemittingEntityIDID of the entity that is the source of the emissionprotected EventIdentifiereventIDID of eventprotected bytenumberOfAPAsThis field shall indicate the number of APAs described in the current UA PDUprotected bytenumberOfShaftsThis field shall represent the number of shafts on a platformprotected bytenumberOfUAEmitterSystemsThis field shall specify the number of UA emitter systems being described in the current UA PDUprotected bytepadpaddingprotected UAPassiveParameterIndexpassiveParameterIndexThis field indicates which database record (or file) shall be used in the definition of passive signature (unintentional) emissions of the entity.protected bytepropulsionPlantConfigurationThis field shall specify the entity propulsion plant configuration.protected java.util.List<ShaftRPM>shaftRPMsshaft RPM values.protected UAStateChangeUpdateIndicatorstateChangeIndicatorThis 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 143Fields inherited from class edu.nps.moves.dis7.Pdu
exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp -
Constructor Summary
Constructors Constructor Description UnderwaterAcousticPdu()Constructor -
Method Summary
Modifier and Type Method Description booleanequals(java.lang.Object obj)booleanequalsImpl(java.lang.Object obj)Compare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied objectjava.util.List<APA>getApaData()Getter forapaDatajava.util.List<UAEmitter>getEmitterSystems()Getter foremitterSystemsEntityIDgetEmittingEntityID()Getter foremittingEntityIDEventIdentifiergetEventID()Getter foreventIDintgetMarshalledSize()Returns the size of this serialized object in bytesbytegetPad()Getter forpadUAPassiveParameterIndexgetPassiveParameterIndex()Getter forpassiveParameterIndexbytegetPropulsionPlantConfiguration()Getter forpropulsionPlantConfigurationjava.util.List<ShaftRPM>getShaftRPMs()Getter forshaftRPMsUAStateChangeUpdateIndicatorgetStateChangeIndicator()Getter forstateChangeIndicatorvoidmarshal(java.io.DataOutputStream dos)Serializes an object to a DataOutputStream.voidmarshal(java.nio.ByteBuffer buff)Packs an object into the ByteBuffer.UnderwaterAcousticPdusetApaData(java.util.List<APA> pApaData)Setter forapaDataUnderwaterAcousticPdusetEmitterSystems(java.util.List<UAEmitter> pEmitterSystems)Setter foremitterSystemsUnderwaterAcousticPdusetEmittingEntityID(EntityID pEmittingEntityID)Setter foremittingEntityIDUnderwaterAcousticPdusetEventID(EventIdentifier pEventID)Setter foreventIDUnderwaterAcousticPdusetPad(byte pPad)Setter forpadUnderwaterAcousticPdusetPassiveParameterIndex(UAPassiveParameterIndex pPassiveParameterIndex)Setter forpassiveParameterIndexUnderwaterAcousticPdusetPropulsionPlantConfiguration(byte pPropulsionPlantConfiguration)Setter forpropulsionPlantConfigurationUnderwaterAcousticPdusetShaftRPMs(java.util.List<ShaftRPM> pShaftRPMs)Setter forshaftRPMsUnderwaterAcousticPdusetStateChangeIndicator(UAStateChangeUpdateIndicator pStateChangeIndicator)Setter forstateChangeIndicatorjava.lang.StringtoString()intunmarshal(java.io.DataInputStream dis)Unserializes an object from a DataInputStream.intunmarshal(java.nio.ByteBuffer buff)Unpacks a Pdu from the underlying data.Methods inherited from class edu.nps.moves.dis7.PduBase
getPadding, getPduStatus, setPadding, setPduStatusMethods inherited from class edu.nps.moves.dis7.Pdu
getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, setExerciseID, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp
-
Field Details
-
emittingEntityID
ID of the entity that is the source of the emission -
eventID
ID of event -
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 padpadding -
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 propulsionPlantConfigurationThis field shall specify the entity propulsion plant configuration. This field is used to determine the passive signature characteristics of an entity. -
numberOfShafts
protected byte numberOfShaftsThis field shall represent the number of shafts on a platform -
numberOfAPAs
protected byte numberOfAPAsThis field shall indicate the number of APAs described in the current UA PDU -
numberOfUAEmitterSystems
protected byte numberOfUAEmitterSystemsThis field shall specify the number of UA emitter systems being described in the current UA PDU -
shaftRPMs
shaft RPM values. -
apaData
additional passive activities -
emitterSystems
-
-
Constructor Details
-
UnderwaterAcousticPdu
public UnderwaterAcousticPdu()Constructor
-
-
Method Details
-
getMarshalledSize
public int getMarshalledSize()Returns the size of this serialized object in bytes- Specified by:
getMarshalledSizein interfaceedu.nps.moves.dis7.Marshaller- Overrides:
getMarshalledSizein classDistributedEmissionsFamilyPdu
-
setEmittingEntityID
Setter foremittingEntityID -
getEmittingEntityID
Getter foremittingEntityID -
setEventID
Setter foreventID -
getEventID
Getter foreventID -
setStateChangeIndicator
public UnderwaterAcousticPdu setStateChangeIndicator(UAStateChangeUpdateIndicator pStateChangeIndicator)Setter forstateChangeIndicator -
getStateChangeIndicator
Getter forstateChangeIndicator -
setPad
Setter forpad -
getPad
public byte getPad()Getter forpad -
setPassiveParameterIndex
public UnderwaterAcousticPdu setPassiveParameterIndex(UAPassiveParameterIndex pPassiveParameterIndex)Setter forpassiveParameterIndex -
getPassiveParameterIndex
Getter forpassiveParameterIndex -
setPropulsionPlantConfiguration
Setter forpropulsionPlantConfiguration -
getPropulsionPlantConfiguration
public byte getPropulsionPlantConfiguration()Getter forpropulsionPlantConfiguration -
setShaftRPMs
Setter forshaftRPMs -
getShaftRPMs
Getter forshaftRPMs -
setApaData
Setter forapaData -
getApaData
Getter forapaData -
setEmitterSystems
Setter foremitterSystems -
getEmitterSystems
Getter foremitterSystems -
marshal
public void marshal(java.io.DataOutputStream dos) throws java.lang.ExceptionSerializes an object to a DataOutputStream.- Specified by:
marshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
marshalin classDistributedEmissionsFamilyPdu- Parameters:
dos- the OutputStream- Throws:
java.lang.Exception- if something goes wrong- See Also:
DataOutputStream
-
unmarshal
public int unmarshal(java.io.DataInputStream dis) throws java.lang.ExceptionUnserializes an object from a DataInputStream.- Specified by:
unmarshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
unmarshalin classDistributedEmissionsFamilyPdu- Parameters:
dis- the InputStream- Returns:
- unmarshalled size
- Throws:
java.lang.Exception- if something goes wrong- See Also:
DataInputStream
-
marshal
public void marshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionPacks an object into the ByteBuffer.- Specified by:
marshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
marshalin classDistributedEmissionsFamilyPdu- Parameters:
buff- The ByteBuffer at the position to begin writing- Throws:
java.nio.BufferOverflowException- if buff is too smalljava.nio.ReadOnlyBufferException- if buff is read onlyjava.lang.Exception- ByteBuffer-generated exception- See Also:
ByteBuffer
-
unmarshal
public int unmarshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionUnpacks a Pdu from the underlying data.- Specified by:
unmarshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
unmarshalin classDistributedEmissionsFamilyPdu- Parameters:
buff- The ByteBuffer at the position to begin reading- Returns:
- marshalled size
- Throws:
java.nio.BufferUnderflowException- if buff is too smalljava.lang.Exception- ByteBuffer-generated exception- See Also:
ByteBuffer
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equalsin classDistributedEmissionsFamilyPdu
-
equalsImpl
public boolean equalsImpl(java.lang.Object obj)Description copied from class:PduCompare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied object- Overrides:
equalsImplin classDistributedEmissionsFamilyPdu- Parameters:
obj- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
public java.lang.String toString()- Overrides:
toStringin classDistributedEmissionsFamilyPdu
-