Class EmitterSystem

java.lang.Object

edu.nps.moves.dis7.pdus.EmitterSystem

All Implemented Interfaces:

Serializable

public class EmitterSystem
extends Object
implements Serializable

This field shall specify information about a particular emitter system. Section 6.2.23.

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 EmitterSystemFunction	emitterFunction	function of the emitter, 8-bit enumeration uid 76
protected byte	emitterIDNumber	emitter ID, 8-bit enumeration
protected EmitterName	emitterName	Name of the emitter, 16-bit enumeration uid 75

Constructor Summary

Constructors

Constructor	Description
EmitterSystem()	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
EmitterSystemFunction	getEmitterFunction()	Getter for emitterFunction
byte	getEmitterIDNumber()	Getter for emitterIDNumber
EmitterName	getEmitterName()	Getter for emitterName
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.
EmitterSystem	setEmitterFunction(EmitterSystemFunction pEmitterFunction)	Setter for emitterFunction
EmitterSystem	setEmitterIDNumber(byte pEmitterIDNumber)	Setter for emitterIDNumber
EmitterSystem	setEmitterIDNumber(int pEmitterIDNumber)	Utility setter for emitterIDNumber
EmitterSystem	setEmitterName(EmitterName pEmitterName)	Setter for emitterName
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

emitterName

protected EmitterName emitterName

Name of the emitter, 16-bit enumeration uid 75

emitterFunction

protected EmitterSystemFunction emitterFunction

function of the emitter, 8-bit enumeration uid 76

emitterIDNumber

protected byte emitterIDNumber

emitter ID, 8-bit enumeration

Constructor Details

EmitterSystem

public EmitterSystem()

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)

setEmitterName

public EmitterSystem setEmitterName(EmitterName pEmitterName)

Setter for emitterName

Parameters:

pEmitterName - new value of interest

Returns:

same object to permit progressive setters

getEmitterName

public EmitterName getEmitterName()

Getter for emitterName

Returns:

value of interest

setEmitterFunction

public EmitterSystem setEmitterFunction(EmitterSystemFunction pEmitterFunction)

Setter for emitterFunction

Parameters:

pEmitterFunction - new value of interest

Returns:

same object to permit progressive setters

getEmitterFunction

public EmitterSystemFunction getEmitterFunction()

Getter for emitterFunction

Returns:

value of interest

setEmitterIDNumber

public EmitterSystem setEmitterIDNumber(byte pEmitterIDNumber)

Setter for emitterIDNumber

Parameters:

pEmitterIDNumber - new value of interest

Returns:

same object to permit progressive setters

setEmitterIDNumber

public EmitterSystem setEmitterIDNumber(int pEmitterIDNumber)

Utility setter for emitterIDNumber

Parameters:

pEmitterIDNumber - new value of interest

Returns:

same object to permit progressive setters

getEmitterIDNumber

public byte getEmitterIDNumber()

Getter for emitterIDNumber

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