com.mak.vrlj.object.RadioReceiver Class Reference

A simulation Receiver object. More...

Inheritance diagram for com.mak.vrlj.object.RadioReceiver:

Collaboration diagram for com.mak.vrlj.object.RadioReceiver:

Public Member Functions
	RadioReceiver (EmbeddedIdentifier id)
	Create a simulation object.
	RadioReceiver (EmbeddedIdentifier id, RadioReceiver Receiver)
	Create a new Receiver by copying an existing Receiver.
boolean	equals (Object obj)
String	getClassName ()
	Get the name of the simulation object class for Entity objects.
GlobalObjectDesignator	getEntityIdentifier ()
	Get the GlobalObjectDesignator which links to the parent entity of this Receiver.
EmbeddedIdentifier	getGlobalObjectDesignator ()
String	getHostObjectIdentifier ()
float	getPower ()
	Get the Power of the radio.
short	getRadioId ()
	Get the identifier for this Receiver.
ReceiverState	getReceiverState ()
	Get the ReceiverState of the radio.
GlobalObjectDesignator	getTransmitterEntityId ()
	Get the GlobalObjectDesignator of the transmitter connected to this receiver.
short	getTransmitterRadioId ()
	Get the Transmitter identifier sending to this Receiver.
int	hashCode ()
void	setHostObjectIdentifier (String hostObject)
	Set the Hosting Object if using HLA.
void	setPower (float power)
	Set the Power of the radio.
void	setReceiverState (ReceiverState state)
	Set the ReceiverState of the radio.
void	setTransmitterEntityId (GlobalObjectDesignator identifier)
void	setTransmitterRadioId (short identifier)
String	toString ()

Static Public Member Functions
static void	addListener (ExerciseConnection exConn, ObjectListener< ObjectIdentifier, RadioReceiver > listener)
static void	removeListener (ExerciseConnection exConn, ObjectListener< ObjectIdentifier, RadioReceiver > listener)

Static Public Attributes
static final String	CLASS_NAME = ":RadioReceiver"
	Simulation object class name.

Private Attributes
final EmbeddedIdentifier	myIdentifier
final GlobalObjectDesignator	myEntityId
String	myHostObjectIdentifier
final short	myRadioId
ReceiverState	myReceiverState
float	myPower
GlobalObjectDesignator	myTransmitterEntityId
short	myTransmitterRadioId

Detailed Description

A simulation Receiver object.

Constructor & Destructor Documentation

com.mak.vrlj.object.RadioReceiver.RadioReceiver ( EmbeddedIdentifier  id )

inline

Create a simulation object.

Parameters

name	unique name for this simulation object.

References com.mak.vrlj.object.RadioReceiver.myEntityId, com.mak.vrlj.object.RadioReceiver.myHostObjectIdentifier, com.mak.vrlj.object.RadioReceiver.myIdentifier, com.mak.vrlj.object.RadioReceiver.myPower, com.mak.vrlj.object.RadioReceiver.myRadioId, com.mak.vrlj.object.RadioReceiver.myReceiverState, com.mak.vrlj.object.RadioReceiver.myTransmitterEntityId, com.mak.vrlj.object.RadioReceiver.myTransmitterRadioId, and com.mak.vrlj.datatype.ReceiverState.OFF.

Referenced by com.mak.vrlj.object.RadioReceiver.equals().

com.mak.vrlj.object.RadioReceiver.RadioReceiver ( EmbeddedIdentifier  id, RadioReceiver  Receiver  )

inline

Create a new Receiver by copying an existing Receiver.

Parameters

name	unique name for this simulation object.
entity	an entity which will be copied into the new entity during initialization.

References com.mak.vrlj.object.RadioReceiver.getHostObjectIdentifier(), com.mak.vrlj.object.RadioReceiver.getPower(), com.mak.vrlj.object.RadioReceiver.getReceiverState(), com.mak.vrlj.object.RadioReceiver.getTransmitterEntityId(), com.mak.vrlj.object.RadioReceiver.getTransmitterRadioId(), com.mak.vrlj.object.RadioReceiver.myEntityId, com.mak.vrlj.object.RadioReceiver.myHostObjectIdentifier, com.mak.vrlj.object.RadioReceiver.myIdentifier, com.mak.vrlj.object.RadioReceiver.myPower, com.mak.vrlj.object.RadioReceiver.myRadioId, com.mak.vrlj.object.RadioReceiver.myReceiverState, com.mak.vrlj.object.RadioReceiver.myTransmitterEntityId, and com.mak.vrlj.object.RadioReceiver.myTransmitterRadioId.

Member Function Documentation

static void com.mak.vrlj.object.RadioReceiver.addListener ( ExerciseConnection  exConn, ObjectListener< ObjectIdentifier, RadioReceiver >  listener  )

inlinestatic

References com.mak.vrlj.object.RadioReceiver.CLASS_NAME.

boolean com.mak.vrlj.object.RadioReceiver.equals ( Object  obj )

inline

References com.mak.vrlj.object.GlobalObjectDesignator.equals(), com.mak.vrlj.object.RadioReceiver.myEntityId, com.mak.vrlj.object.RadioReceiver.myHostObjectIdentifier, com.mak.vrlj.object.RadioReceiver.myPower, com.mak.vrlj.object.RadioReceiver.myRadioId, com.mak.vrlj.object.RadioReceiver.myReceiverState, com.mak.vrlj.object.RadioReceiver.myTransmitterEntityId, com.mak.vrlj.object.RadioReceiver.myTransmitterRadioId, and com.mak.vrlj.object.RadioReceiver.RadioReceiver().

String com.mak.vrlj.object.RadioReceiver.getClassName ( )

inline

Get the name of the simulation object class for Entity objects.

References com.mak.vrlj.object.RadioReceiver.CLASS_NAME.

GlobalObjectDesignator com.mak.vrlj.object.RadioReceiver.getEntityIdentifier ( )

inline

Get the GlobalObjectDesignator which links to the parent entity of this Receiver.

Returns

GlobalObjectDesignator of the parent entity.

References com.mak.vrlj.object.RadioReceiver.myEntityId.

EmbeddedIdentifier com.mak.vrlj.object.RadioReceiver.getGlobalObjectDesignator ( )

inline

References com.mak.vrlj.object.RadioReceiver.myIdentifier.

String com.mak.vrlj.object.RadioReceiver.getHostObjectIdentifier ( )

inline

Returns

the Host Object Identifier if using HLA

References com.mak.vrlj.object.RadioReceiver.myHostObjectIdentifier.

Referenced by com.mak.vrlj.object.RadioReceiver.RadioReceiver().

float com.mak.vrlj.object.RadioReceiver.getPower ( )

inline

Get the Power of the radio.

Returns

the Power of the radio

References com.mak.vrlj.object.RadioReceiver.myPower.

Referenced by com.mak.vrlj.object.RadioReceiver.RadioReceiver().

short com.mak.vrlj.object.RadioReceiver.getRadioId ( )

inline

Get the identifier for this Receiver.

Should be unique for each entity.

Returns

the identifier for this Receiver

References com.mak.vrlj.object.RadioReceiver.myRadioId.

ReceiverState com.mak.vrlj.object.RadioReceiver.getReceiverState ( )

inline

Get the ReceiverState of the radio.

Returns

the ReceiverState of the radio

References com.mak.vrlj.object.RadioReceiver.myReceiverState.

Referenced by com.mak.vrlj.object.RadioReceiver.RadioReceiver().

GlobalObjectDesignator com.mak.vrlj.object.RadioReceiver.getTransmitterEntityId ( )

inline

Get the GlobalObjectDesignator of the transmitter connected to this receiver.

Returns

the GlobalObjectDesignator of the transmitter connected to this receiver

References com.mak.vrlj.object.RadioReceiver.myTransmitterEntityId.

Referenced by com.mak.vrlj.object.RadioReceiver.RadioReceiver().

short com.mak.vrlj.object.RadioReceiver.getTransmitterRadioId ( )

inline

Get the Transmitter identifier sending to this Receiver.

Returns

the Transmitter identifier sending to this Receiver.

References com.mak.vrlj.object.RadioReceiver.myTransmitterRadioId.

Referenced by com.mak.vrlj.object.RadioReceiver.RadioReceiver().

int com.mak.vrlj.object.RadioReceiver.hashCode ( )

inline

References com.mak.vrlj.object.RadioReceiver.myEntityId, com.mak.vrlj.object.RadioReceiver.myHostObjectIdentifier, com.mak.vrlj.object.RadioReceiver.myPower, com.mak.vrlj.object.RadioReceiver.myRadioId, com.mak.vrlj.object.RadioReceiver.myReceiverState, com.mak.vrlj.object.RadioReceiver.myTransmitterEntityId, and com.mak.vrlj.object.RadioReceiver.myTransmitterRadioId.

static void com.mak.vrlj.object.RadioReceiver.removeListener ( ExerciseConnection  exConn, ObjectListener< ObjectIdentifier, RadioReceiver >  listener  )

inlinestatic

References com.mak.vrlj.object.RadioReceiver.CLASS_NAME.

void com.mak.vrlj.object.RadioReceiver.setHostObjectIdentifier ( String  hostObject )

inline

Set the Hosting Object if using HLA.

Parameters

the	Hosting Object if using HLA

References com.mak.vrlj.object.RadioReceiver.myHostObjectIdentifier.

void com.mak.vrlj.object.RadioReceiver.setPower ( float  power )

inline

Set the Power of the radio.

Parameters

the	Power of the radio

References com.mak.vrlj.object.RadioReceiver.myPower.

void com.mak.vrlj.object.RadioReceiver.setReceiverState ( ReceiverState  state )

inline

Set the ReceiverState of the radio.

Parameters

the	ReceiverState of the radio

References com.mak.vrlj.object.RadioReceiver.myReceiverState.

void com.mak.vrlj.object.RadioReceiver.setTransmitterEntityId ( GlobalObjectDesignator  identifier )

inline

Parameters

Transmitter

entity sending to this Receiver.

References com.mak.vrlj.object.RadioReceiver.myTransmitterEntityId.

void com.mak.vrlj.object.RadioReceiver.setTransmitterRadioId ( short  identifier )

inline

Parameters

Transmitter

identifier sending to this Receiver.

References com.mak.vrlj.object.RadioReceiver.myTransmitterRadioId.

String com.mak.vrlj.object.RadioReceiver.toString ( )

inline

References com.mak.vrlj.object.RadioReceiver.myEntityId, com.mak.vrlj.object.RadioReceiver.myHostObjectIdentifier, com.mak.vrlj.object.RadioReceiver.myPower, com.mak.vrlj.object.RadioReceiver.myRadioId, com.mak.vrlj.object.RadioReceiver.myReceiverState, com.mak.vrlj.object.RadioReceiver.myTransmitterEntityId, and com.mak.vrlj.object.RadioReceiver.myTransmitterRadioId.

Member Data Documentation

final String com.mak.vrlj.object.RadioReceiver.CLASS_NAME = ":RadioReceiver"

static

Simulation object class name.

Referenced by com.mak.vrlj.object.RadioReceiver.addListener(), com.mak.vrlj.object.RadioReceiver.getClassName(), com.mak.vrlj.object.ReflectedRadioReceiverMap.ReflectedRadioReceiverMap(), and com.mak.vrlj.object.RadioReceiver.removeListener().

final GlobalObjectDesignator com.mak.vrlj.object.RadioReceiver.myEntityId

private

Referenced by com.mak.vrlj.object.RadioReceiver.equals(), com.mak.vrlj.object.RadioReceiver.getEntityIdentifier(), com.mak.vrlj.object.RadioReceiver.hashCode(), com.mak.vrlj.object.RadioReceiver.RadioReceiver(), and com.mak.vrlj.object.RadioReceiver.toString().

String com.mak.vrlj.object.RadioReceiver.myHostObjectIdentifier

private

Referenced by com.mak.vrlj.object.RadioReceiver.equals(), com.mak.vrlj.object.RadioReceiver.getHostObjectIdentifier(), com.mak.vrlj.object.RadioReceiver.hashCode(), com.mak.vrlj.object.RadioReceiver.RadioReceiver(), com.mak.vrlj.object.RadioReceiver.setHostObjectIdentifier(), and com.mak.vrlj.object.RadioReceiver.toString().

final EmbeddedIdentifier com.mak.vrlj.object.RadioReceiver.myIdentifier

private

Referenced by com.mak.vrlj.object.RadioReceiver.getGlobalObjectDesignator(), and com.mak.vrlj.object.RadioReceiver.RadioReceiver().

float com.mak.vrlj.object.RadioReceiver.myPower

private

Referenced by com.mak.vrlj.object.RadioReceiver.equals(), com.mak.vrlj.object.RadioReceiver.getPower(), com.mak.vrlj.object.RadioReceiver.hashCode(), com.mak.vrlj.object.RadioReceiver.RadioReceiver(), com.mak.vrlj.object.RadioReceiver.setPower(), and com.mak.vrlj.object.RadioReceiver.toString().

final short com.mak.vrlj.object.RadioReceiver.myRadioId

private

Referenced by com.mak.vrlj.object.RadioReceiver.equals(), com.mak.vrlj.object.RadioReceiver.getRadioId(), com.mak.vrlj.object.RadioReceiver.hashCode(), com.mak.vrlj.object.RadioReceiver.RadioReceiver(), and com.mak.vrlj.object.RadioReceiver.toString().

ReceiverState com.mak.vrlj.object.RadioReceiver.myReceiverState

private

Referenced by com.mak.vrlj.object.RadioReceiver.equals(), com.mak.vrlj.object.RadioReceiver.getReceiverState(), com.mak.vrlj.object.RadioReceiver.hashCode(), com.mak.vrlj.object.RadioReceiver.RadioReceiver(), com.mak.vrlj.object.RadioReceiver.setReceiverState(), and com.mak.vrlj.object.RadioReceiver.toString().

GlobalObjectDesignator com.mak.vrlj.object.RadioReceiver.myTransmitterEntityId

private

Referenced by com.mak.vrlj.object.RadioReceiver.equals(), com.mak.vrlj.object.RadioReceiver.getTransmitterEntityId(), com.mak.vrlj.object.RadioReceiver.hashCode(), com.mak.vrlj.object.RadioReceiver.RadioReceiver(), com.mak.vrlj.object.RadioReceiver.setTransmitterEntityId(), and com.mak.vrlj.object.RadioReceiver.toString().

short com.mak.vrlj.object.RadioReceiver.myTransmitterRadioId

private

Referenced by com.mak.vrlj.object.RadioReceiver.equals(), com.mak.vrlj.object.RadioReceiver.getTransmitterRadioId(), com.mak.vrlj.object.RadioReceiver.hashCode(), com.mak.vrlj.object.RadioReceiver.RadioReceiver(), com.mak.vrlj.object.RadioReceiver.setTransmitterRadioId(), and com.mak.vrlj.object.RadioReceiver.toString().

---

The documentation for this class was generated from the following file:

• RadioReceiver.java