edu.nps.moves.dis
Class UaPdu

java.lang.Object
  edu.nps.moves.dis.Pdu
      edu.nps.moves.dis.DistributedEmissionsFamilyPdu
          edu.nps.moves.dis.UaPdu

All Implemented Interfaces:

java.io.Serializable

@Entity
public class UaPdu
extends DistributedEmissionsFamilyPdu
implements java.io.Serializable

Section 5.3.7.3. Information about underwater acoustic emmissions. This requires manual cleanup. The beam data records should ALL be a the finish, rather than attached to each emitter system. UNFINISHED Copyright (c) 2008-2010, MOVES Institute, Naval Postgraduate School. All rights reserved. This work is licensed under the BSD open source license, available at https://www.movesinstitute.org/licenses/bsd.html

Author:

DMcG

See Also:

Serialized Form

Field Summary

protected java.util.List<ApaData>	apaData apaData
protected java.util.List<AcousticEmitterSystemData>	emitterSystems
protected EntityID	emittingEntityID ID of the entity that is the source of the emission
protected EventID	eventID ID of event
long	fk_emittingEntityID
long	fk_eventID
protected short	numberOfAPAs This field shall indicate the number of APAs described in the current UA PDU
protected short	numberOfShafts This field shall represent the number of shafts on a platform
protected short	numberOfUAEmitterSystems This field shall specify the number of UA emitter systems being described in the current UA PDU
protected byte	pad padding
protected int	passiveParameterIndex This field indicates which database record (or file) shall be used in the definition of passive signature (unintentional) emissions of the entity.
protected short	propulsionPlantConfiguration This field shall specify the entity propulsion plant configuration.
protected java.util.List<ShaftRPMs>	shaftRPMs shaft RPM values
protected byte	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

Fields inherited from class edu.nps.moves.dis.Pdu

exerciseID, padding, pduLength, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

UaPdu()
Constructor

Method Summary

boolean	equals(java.lang.Object obj)
boolean	equalsImpl(java.lang.Object obj) Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
java.util.List<ApaData>	getApaData()
java.util.List<AcousticEmitterSystemData>	getEmitterSystems()
EntityID	getEmittingEntityID()
EventID	getEventID()
int	getMarshalledSize()
short	getNumberOfAPAs()
short	getNumberOfShafts()
short	getNumberOfUAEmitterSystems()
byte	getPad()
int	getPassiveParameterIndex()
short	getPropulsionPlantConfiguration()
java.util.List<ShaftRPMs>	getShaftRPMs()
byte	getStateChangeIndicator()
void	marshal(java.nio.ByteBuffer buff) Packs a Pdu into the ByteBuffer.
void	marshal(java.io.DataOutputStream dos)
void	setApaData(java.util.List<ApaData> pApaData)
void	setEmitterSystems(java.util.List<AcousticEmitterSystemData> pEmitterSystems)
void	setEmittingEntityID(EntityID pEmittingEntityID)
void	setEventID(EventID pEventID)
void	setNumberOfAPAs(short pNumberOfAPAs) Note that setting this value will not change the marshalled value.
void	setNumberOfShafts(short pNumberOfShafts) Note that setting this value will not change the marshalled value.
void	setNumberOfUAEmitterSystems(short pNumberOfUAEmitterSystems) Note that setting this value will not change the marshalled value.
void	setPad(byte pPad)
void	setPassiveParameterIndex(int pPassiveParameterIndex)
void	setPropulsionPlantConfiguration(short pPropulsionPlantConfiguration)
void	setShaftRPMs(java.util.List<ShaftRPMs> pShaftRPMs)
void	setStateChangeIndicator(byte pStateChangeIndicator)
void	unmarshal(java.nio.ByteBuffer buff) Unpacks a Pdu from the underlying data.
void	unmarshal(java.io.DataInputStream dis)

Methods inherited from class edu.nps.moves.dis.Pdu

getExerciseID, getLength, getPadding, getPduLength, getPduType, getPduTypeEnum, getPk_Pdu, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, marshalWithDisAbsoluteTimestamp, marshalWithDisAbsoluteTimestamp, marshalWithDisRelativeTimestamp, marshalWithDisRelativeTimestamp, marshalWithNpsTimestamp, marshalWithNpsTimestamp, marshalWithUnixTimestamp, marshalWithUnixTimestamp, readUnsignedInt, readUnsignedInt, setExerciseID, setPadding, setPduLength, setPduType, setPk_Pdu, setProtocolFamily, setProtocolVersion, setTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

emittingEntityID

protected EntityID emittingEntityID

ID of the entity that is the source of the emission

eventID

protected EventID eventID

ID of event

stateChangeIndicator

protected byte 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

pad

protected byte pad

padding

passiveParameterIndex

protected int 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.

propulsionPlantConfiguration

protected short 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 short numberOfShafts

This field shall represent the number of shafts on a platform

numberOfAPAs

protected short numberOfAPAs

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

numberOfUAEmitterSystems

protected short numberOfUAEmitterSystems

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

shaftRPMs

protected java.util.List<ShaftRPMs> shaftRPMs

shaft RPM values

apaData

protected java.util.List<ApaData> apaData

apaData

emitterSystems

protected java.util.List<AcousticEmitterSystemData> emitterSystems

fk_emittingEntityID

public long fk_emittingEntityID

fk_eventID

public long fk_eventID

Constructor Detail

UaPdu

public UaPdu()

Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()

Overrides:

getMarshalledSize in class DistributedEmissionsFamilyPdu

setEmittingEntityID

public void setEmittingEntityID(EntityID pEmittingEntityID)

getEmittingEntityID

public EntityID getEmittingEntityID()

setEventID

public void setEventID(EventID pEventID)

getEventID

public EventID getEventID()

setStateChangeIndicator

public void setStateChangeIndicator(byte pStateChangeIndicator)

getStateChangeIndicator

public byte getStateChangeIndicator()

setPad

public void setPad(byte pPad)

getPad

public byte getPad()

setPassiveParameterIndex

public void setPassiveParameterIndex(int pPassiveParameterIndex)

getPassiveParameterIndex

public int getPassiveParameterIndex()

setPropulsionPlantConfiguration

public void setPropulsionPlantConfiguration(short pPropulsionPlantConfiguration)

getPropulsionPlantConfiguration

public short getPropulsionPlantConfiguration()

getNumberOfShafts

public short getNumberOfShafts()

setNumberOfShafts

public void setNumberOfShafts(short pNumberOfShafts)

Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose. The getnumberOfShafts method will also be based on the actual list length rather than this value. The method is simply here for java bean completeness.

getNumberOfAPAs

public short getNumberOfAPAs()

setNumberOfAPAs

public void setNumberOfAPAs(short pNumberOfAPAs)

Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose. The getnumberOfAPAs method will also be based on the actual list length rather than this value. The method is simply here for java bean completeness.

getNumberOfUAEmitterSystems

public short getNumberOfUAEmitterSystems()

setNumberOfUAEmitterSystems

public void setNumberOfUAEmitterSystems(short pNumberOfUAEmitterSystems)

Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose. The getnumberOfUAEmitterSystems method will also be based on the actual list length rather than this value. The method is simply here for java bean completeness.

setShaftRPMs

public void setShaftRPMs(java.util.List<ShaftRPMs> pShaftRPMs)

getShaftRPMs

public java.util.List<ShaftRPMs> getShaftRPMs()

setApaData

public void setApaData(java.util.List<ApaData> pApaData)

getApaData

public java.util.List<ApaData> getApaData()

setEmitterSystems

public void setEmitterSystems(java.util.List<AcousticEmitterSystemData> pEmitterSystems)

getEmitterSystems

public java.util.List<AcousticEmitterSystemData> getEmitterSystems()

marshal

public void marshal(java.io.DataOutputStream dos)

Overrides:

marshal in class DistributedEmissionsFamilyPdu

unmarshal

public void unmarshal(java.io.DataInputStream dis)

Overrides:

unmarshal in class DistributedEmissionsFamilyPdu

marshal

public void marshal(java.nio.ByteBuffer buff)

Packs a Pdu into the ByteBuffer.

Overrides:

marshal in class DistributedEmissionsFamilyPdu

Parameters:

buff - The ByteBuffer at the position to begin writing

Throws:

java.nio.BufferOverflowException - if buff is too small

java.nio.ReadOnlyBufferException - if buff is read only

Since:

??

See Also:

ByteBuffer

unmarshal

public void unmarshal(java.nio.ByteBuffer buff)

Unpacks a Pdu from the underlying data.

Overrides:

unmarshal in class DistributedEmissionsFamilyPdu

Parameters:

buff - The ByteBuffer at the position to begin reading

Throws:

java.nio.BufferUnderflowException - if buff is too small

Since:

??

See Also:

ByteBuffer

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class DistributedEmissionsFamilyPdu

equalsImpl

public boolean equalsImpl(java.lang.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 DistributedEmissionsFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.