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. More...
String	getClassName ()
	Get the name of the simulation object class for Entity objects. More...
float	getPower ()
	Get the Power of the radio. More...
ReceiverState	getReceiverState ()
	Get the ReceiverState of the radio. More...
GlobalObjectDesignator	getTransmitterEntityId ()
	Get the GlobalObjectDesignator of the transmitter connected to this receiver. More...
short	getTransmitterRadioId ()
	Get the Transmitter identifier sending to this Receiver. More...
void	setPower (float power)
	Set the Power of the radio. More...
void	setReceiverState (ReceiverState state)
	Set the ReceiverState of the radio. More...
void	setTransmitterEntityId (GlobalObjectDesignator identifier)
void	setTransmitterRadioId (short identifier)
int	hashCode ()
boolean	equals (Object obj)
String	toString ()
Public Member Functions inherited from com.mak.vrlj.object.EmbeddedSystem
	EmbeddedSystem (EmbeddedIdentifier id)
EmbeddedIdentifier	getGlobalObjectDesignator ()
GlobalObjectDesignator	getHostGlobalIdentifier ()
short	getEmbeddedId ()
Vector3f	getRelativePosition ()
void	setRelativePosition (Vector3f relPos)
EntityIdentifier	getHostEntityIdentifier ()
void	setHostEntityIdentifier (EntityIdentifier hostEntityIdentifier)
int	hashCode ()
boolean	equals (Object obj)
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	NAME = "RadioReceiver"
	Simulation object class name. More...

Private Attributes
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.myPower, 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().

Member Function Documentation

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

inlinestatic

References com.mak.vrlj.object.RadioReceiver.NAME.

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

inline

References com.mak.vrlj.object.GlobalObjectDesignator.equals(), com.mak.vrlj.object.RadioReceiver.myPower, 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 ( )

inlinevirtual

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

Implements com.mak.vrlj.object.EmbeddedSystem.

References com.mak.vrlj.object.RadioReceiver.NAME.

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.

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.

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.

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.

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

inline

References com.mak.vrlj.object.RadioReceiver.myPower, 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.NAME.

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.myPower, com.mak.vrlj.object.RadioReceiver.myReceiverState, com.mak.vrlj.object.RadioReceiver.myTransmitterEntityId, and com.mak.vrlj.object.RadioReceiver.myTransmitterRadioId.

Member Data Documentation

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().

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().

final String com.mak.vrlj.object.RadioReceiver.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().

---

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

• RadioReceiver.java