Class AcousticEmitter

java.lang.Object

edu.nps.moves.dis7.pdus.AcousticEmitter

All Implemented Interfaces:

Serializable

public class AcousticEmitter
extends Object
implements Serializable

Information about a specific UA emitter. Section 6.2.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 UAAcousticEmitterSystemFunction	acousticFunction	The function of the acoustic system uid 145
protected byte	acousticIDNumber	The UA emitter identification number relative to a specific system
protected UAAcousticSystemName	acousticSystemName	The system for a particular UA emitter, and an enumeration uid 144

Constructor Summary

Constructors

Constructor	Description
AcousticEmitter()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
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
UAAcousticEmitterSystemFunction	getAcousticFunction()	Getter for acousticFunction
byte	getAcousticIDNumber()	Getter for acousticIDNumber
UAAcousticSystemName	getAcousticSystemName()	Getter for acousticSystemName
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
AcousticEmitter	setAcousticFunction(UAAcousticEmitterSystemFunction pAcousticFunction)	Setter for acousticFunction
AcousticEmitter	setAcousticIDNumber(byte pAcousticIDNumber)	Setter for acousticIDNumber
AcousticEmitter	setAcousticIDNumber(int pAcousticIDNumber)	Utility setter for acousticIDNumber
AcousticEmitter	setAcousticSystemName(UAAcousticSystemName pAcousticSystemName)	Setter for acousticSystemName
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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

acousticSystemName

protected UAAcousticSystemName acousticSystemName

The system for a particular UA emitter, and an enumeration uid 144

acousticFunction

protected UAAcousticEmitterSystemFunction acousticFunction

The function of the acoustic system uid 145

acousticIDNumber

protected byte acousticIDNumber

The UA emitter identification number relative to a specific system

Constructor Details

AcousticEmitter

public AcousticEmitter()

Constructor creates and configures a new instance object

Method Details

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Returns:

serialized size in bytes

See Also:

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

setAcousticSystemName

public AcousticEmitter setAcousticSystemName(UAAcousticSystemName pAcousticSystemName)

Setter for acousticSystemName

Parameters:

pAcousticSystemName - new value of interest

Returns:

same object to permit progressive setters

getAcousticSystemName

public UAAcousticSystemName getAcousticSystemName()

Getter for acousticSystemName

Returns:

value of interest

setAcousticFunction

public AcousticEmitter setAcousticFunction(UAAcousticEmitterSystemFunction pAcousticFunction)

Setter for acousticFunction

Parameters:

pAcousticFunction - new value of interest

Returns:

same object to permit progressive setters

getAcousticFunction

public UAAcousticEmitterSystemFunction getAcousticFunction()

Getter for acousticFunction

Returns:

value of interest

setAcousticIDNumber

public AcousticEmitter setAcousticIDNumber(byte pAcousticIDNumber)

Setter for acousticIDNumber

Parameters:

pAcousticIDNumber - new value of interest

Returns:

same object to permit progressive setters

setAcousticIDNumber

public AcousticEmitter setAcousticIDNumber(int pAcousticIDNumber)

Utility setter for acousticIDNumber

Parameters:

pAcousticIDNumber - new value of interest

Returns:

same object to permit progressive setters

getAcousticIDNumber

public byte getAcousticIDNumber()

Getter for acousticIDNumber

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

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.

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.

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.

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 Object

equalsImpl

public boolean equalsImpl(Object obj)

Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object