Class EmitterBeam

java.lang.Object

edu.nps.moves.dis7.pdus.EmitterBeam

All Implemented Interfaces:

Serializable

public class EmitterBeam
extends Object
implements Serializable

Emitter beams focused emissions from an electromagnetic or active acoustic transmitter. The beam is defined by the main lobe of the antenna pattern.

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 BeamData	beamData	beamData is an undescribed parameter...
protected byte	beamDataLength	beamDataLength is an undescribed parameter...
protected ElectromagneticEmissionBeamFunction	beamFunction	uid 78
protected byte	beamNumber	beamNumber is an undescribed parameter...
protected short	beamParameterIndex	beamParameterIndex is an undescribed parameter...
protected BeamStatus	beamStatus	beamStatus is an undescribed parameter...
protected EEFundamentalParameterData	fundamentalParameterData	fundamentalParameterData is an undescribed parameter...
protected HighDensityTrackJam	highDensityTrackJam	uid 79
protected JammingTechnique	jammingTechnique	jammingTechnique is an undescribed parameter...
protected byte	numberOfTargets	numberOfTargets is an undescribed parameter...
protected List<TrackJamData>	trackJamData	trackJamData is an undescribed parameter...

Constructor Summary

Constructors

Constructor	Description
EmitterBeam()	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
BeamData	getBeamData()	Getter for beamData
byte	getBeamDataLength()	Getter for beamDataLength
ElectromagneticEmissionBeamFunction	getBeamFunction()	Getter for beamFunction
byte	getBeamNumber()	Getter for beamNumber
short	getBeamParameterIndex()	Getter for beamParameterIndex
BeamStatus	getBeamStatus()	Getter for beamStatus
EEFundamentalParameterData	getFundamentalParameterData()	Getter for fundamentalParameterData
HighDensityTrackJam	getHighDensityTrackJam()	Getter for highDensityTrackJam
JammingTechnique	getJammingTechnique()	Getter for jammingTechnique
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
List<TrackJamData>	getTrackJamData()	Getter for trackJamData
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
EmitterBeam	setBeamData(BeamData pBeamData)	Setter for beamData
EmitterBeam	setBeamDataLength(byte pBeamDataLength)	Setter for beamDataLength
EmitterBeam	setBeamDataLength(int pBeamDataLength)	Utility setter for beamDataLength
EmitterBeam	setBeamFunction(ElectromagneticEmissionBeamFunction pBeamFunction)	Setter for beamFunction
EmitterBeam	setBeamNumber(byte pBeamNumber)	Setter for beamNumber
EmitterBeam	setBeamNumber(int pBeamNumber)	Utility setter for beamNumber
EmitterBeam	setBeamParameterIndex(int pBeamParameterIndex)	Utility setter for beamParameterIndex
EmitterBeam	setBeamParameterIndex(short pBeamParameterIndex)	Setter for beamParameterIndex
EmitterBeam	setBeamStatus(BeamStatus pBeamStatus)	Setter for beamStatus
EmitterBeam	setFundamentalParameterData(EEFundamentalParameterData pFundamentalParameterData)	Setter for fundamentalParameterData
EmitterBeam	setHighDensityTrackJam(HighDensityTrackJam pHighDensityTrackJam)	Setter for highDensityTrackJam
EmitterBeam	setJammingTechnique(JammingTechnique pJammingTechnique)	Setter for jammingTechnique
EmitterBeam	setTrackJamData(List<TrackJamData> pTrackJamData)	Setter for trackJamData
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

beamDataLength

protected byte beamDataLength

beamDataLength is an undescribed parameter...

beamNumber

protected byte beamNumber

beamNumber is an undescribed parameter...

beamParameterIndex

protected short beamParameterIndex

beamParameterIndex is an undescribed parameter...

fundamentalParameterData

protected EEFundamentalParameterData fundamentalParameterData

fundamentalParameterData is an undescribed parameter...

beamData

protected BeamData beamData

beamData is an undescribed parameter...

beamFunction

protected ElectromagneticEmissionBeamFunction beamFunction

uid 78

numberOfTargets

protected byte numberOfTargets

numberOfTargets is an undescribed parameter...

highDensityTrackJam

protected HighDensityTrackJam highDensityTrackJam

uid 79

beamStatus

protected BeamStatus beamStatus

beamStatus is an undescribed parameter...

jammingTechnique

protected JammingTechnique jammingTechnique

jammingTechnique is an undescribed parameter...

trackJamData

protected List<TrackJamData> trackJamData

trackJamData is an undescribed parameter...

Constructor Details

EmitterBeam

public EmitterBeam()

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)

setBeamDataLength

public EmitterBeam setBeamDataLength(byte pBeamDataLength)

Setter for beamDataLength

Parameters:

pBeamDataLength - new value of interest

Returns:

same object to permit progressive setters

setBeamDataLength

public EmitterBeam setBeamDataLength(int pBeamDataLength)

Utility setter for beamDataLength

Parameters:

pBeamDataLength - new value of interest

Returns:

same object to permit progressive setters

getBeamDataLength

public byte getBeamDataLength()

Getter for beamDataLength

Returns:

value of interest

setBeamNumber

public EmitterBeam setBeamNumber(byte pBeamNumber)

Setter for beamNumber

Parameters:

pBeamNumber - new value of interest

Returns:

same object to permit progressive setters

setBeamNumber

public EmitterBeam setBeamNumber(int pBeamNumber)

Utility setter for beamNumber

Parameters:

pBeamNumber - new value of interest

Returns:

same object to permit progressive setters

getBeamNumber

public byte getBeamNumber()

Getter for beamNumber

Returns:

value of interest

setBeamParameterIndex

public EmitterBeam setBeamParameterIndex(short pBeamParameterIndex)

Setter for beamParameterIndex

Parameters:

pBeamParameterIndex - new value of interest

Returns:

same object to permit progressive setters

setBeamParameterIndex

public EmitterBeam setBeamParameterIndex(int pBeamParameterIndex)

Utility setter for beamParameterIndex

Parameters:

pBeamParameterIndex - new value of interest

Returns:

same object to permit progressive setters

getBeamParameterIndex

public short getBeamParameterIndex()

Getter for beamParameterIndex

Returns:

value of interest

setFundamentalParameterData

public EmitterBeam setFundamentalParameterData(EEFundamentalParameterData pFundamentalParameterData)

Setter for fundamentalParameterData

Parameters:

pFundamentalParameterData - new value of interest

Returns:

same object to permit progressive setters

getFundamentalParameterData

public EEFundamentalParameterData getFundamentalParameterData()

Getter for fundamentalParameterData

Returns:

value of interest

setBeamData

public EmitterBeam setBeamData(BeamData pBeamData)

Setter for beamData

Parameters:

pBeamData - new value of interest

Returns:

same object to permit progressive setters

getBeamData

public BeamData getBeamData()

Getter for beamData

Returns:

value of interest

setBeamFunction

public EmitterBeam setBeamFunction(ElectromagneticEmissionBeamFunction pBeamFunction)

Setter for beamFunction

Parameters:

pBeamFunction - new value of interest

Returns:

same object to permit progressive setters

getBeamFunction

public ElectromagneticEmissionBeamFunction getBeamFunction()

Getter for beamFunction

Returns:

value of interest

setHighDensityTrackJam

public EmitterBeam setHighDensityTrackJam(HighDensityTrackJam pHighDensityTrackJam)

Setter for highDensityTrackJam

Parameters:

pHighDensityTrackJam - new value of interest

Returns:

same object to permit progressive setters

getHighDensityTrackJam

public HighDensityTrackJam getHighDensityTrackJam()

Getter for highDensityTrackJam

Returns:

value of interest

setBeamStatus

public EmitterBeam setBeamStatus(BeamStatus pBeamStatus)

Setter for beamStatus

Parameters:

pBeamStatus - new value of interest

Returns:

same object to permit progressive setters

getBeamStatus

public BeamStatus getBeamStatus()

Getter for beamStatus

Returns:

value of interest

setJammingTechnique

public EmitterBeam setJammingTechnique(JammingTechnique pJammingTechnique)

Setter for jammingTechnique

Parameters:

pJammingTechnique - new value of interest

Returns:

same object to permit progressive setters

getJammingTechnique

public JammingTechnique getJammingTechnique()

Getter for jammingTechnique

Returns:

value of interest

setTrackJamData

public EmitterBeam setTrackJamData(List<TrackJamData> pTrackJamData)

Setter for trackJamData

Parameters:

pTrackJamData - new value of interest

Returns:

same object to permit progressive setters

getTrackJamData

public List<TrackJamData> getTrackJamData()

Getter for trackJamData

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