VR-Link JAVA API Documentation
 All Classes Namespaces Files Functions Variables Enumerator Pages
List of all members | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes
com.mak.vrlj.object.RadioTransmitter Class Reference

A simulation transmitter object. More...

+ Inheritance diagram for com.mak.vrlj.object.RadioTransmitter:
+ Collaboration diagram for com.mak.vrlj.object.RadioTransmitter:

Public Member Functions

 RadioTransmitter (EmbeddedIdentifier id)
 Create a simulation object. More...
 
byte[] getAntennaPatternParameters ()
 Get the Antenna Pattern Parameters of the radio. More...
 
AntennaPatternType getAntennaPatternType ()
 Get the AntennaPatternType of the radio. More...
 
String getClassName ()
 Get the name of the simulation object class for Entity objects. More...
 
short getCryptoKey ()
 Get the Crypto Key of the radio. More...
 
CryptoMode getCryptoMode ()
 Get the CryptoMode of the radio. More...
 
CryptoSystem getCryptoSystem ()
 Get the CryptoSystem of the radio. More...
 
boolean getFreqHopInUse ()
 
long getFrequency ()
 Get the Frequency of the radio. More...
 
InputSource getInputSource ()
 Get the InputSource of the radio. More...
 
byte[] getModulationParameters ()
 Get the Modulation Parameters of the radio. More...
 
ModulationType getModulationType ()
 Get the ModulationType of the radio. More...
 
float getPower ()
 Get the Power of the radio. More...
 
boolean getPseudoNoiseInUse ()
 
EntityType getRadioEntityType ()
 Get the EntityType of this transmitter. More...
 
ConstVector3f getRelativeAntennaLocation ()
 Get the relative location of the radio antenna. More...
 
boolean getTimeHopInUse ()
 
float getTransmitBandwidth ()
 Get the TransmitBandwidth of the radio. More...
 
TransmitState getTransmitState ()
 Get the TransmitState of the radio. More...
 
ConstVector3d getWorldAntennaLocation ()
 Get the absolute location of the radio antenna. More...
 
void setAntennaPatternParameters (byte[] antennaPatternParameters)
 Set the Antenna Pattern Parameters of the radio. More...
 
void setAntennaPatternType (AntennaPatternType antennaPatternType)
 Set the AntennaPatternType of the radio. More...
 
void setCryptoKey (short cryptoKey)
 Set the Crypto Key of the radio. More...
 
void setCryptoMode (CryptoMode cryptoMode)
 Set the CryptoMode of the radio. More...
 
void setCryptoSystem (CryptoSystem cryptoSystem)
 Set the CryptoSystem of the radio. More...
 
void setFreqHopInUse (boolean freqHopInUse)
 
void setFrequency (long frequency)
 Set the Frequency of the radio. More...
 
void setInputSource (InputSource inputSource)
 Set the InputSource of the radio. More...
 
void setModulationParameters (byte[] modulationParameters)
 Set the Modulation Parameters of the radio. More...
 
void setModulationType (ModulationType modulationType)
 Set the ModulationType of the radio. More...
 
void setPower (float power)
 Set the Power of the radio. More...
 
void setPseudoNoiseInUse (boolean pseudoNoiseInUse)
 
void setRadioEntityType (EntityType radioEntityType)
 
void setRelativeAntennaLocation (Vector3f relativeAntennaLocation)
 Set the relative location of the radio antenna. More...
 
void setTimeHopInUse (boolean timeHopInUse)
 
void setTransmitBandwidth (float transmitBandwidth)
 Set the TransmitBandwidth of the radio. More...
 
void setTransmitState (TransmitState state)
 Set the TransmitState of the radio. More...
 
void setWorldAntennaLocation (Vector3d worldLocation)
 Set the absolute location of the radio antenna. More...
 
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, RadioTransmitter > listener)
 
static void removeListener (ExerciseConnection exConn, ObjectListener< ObjectIdentifier, RadioTransmitter > listener)
 

Static Public Attributes

static final String NAME = "RadioTransmitter"
 Simulation object class name. More...
 

Private Attributes

EntityType myRadioEntityType
 
TransmitState myTransmitState
 
InputSource myInputSource
 
Vector3d myWorldAntennaLocation
 
Vector3f myRelativeAntennaLocation
 
AntennaPatternType myAntennaPatternType
 
long myFrequency
 
float myTransmitBandwidth
 
float myPower
 
ModulationType myModulationType
 
CryptoMode myCryptoMode
 
CryptoSystem myCryptoSystem
 
short myCryptoKey
 
byte[] myModulationParameters
 
byte[] myAntennaPatternParameters
 
boolean myFreqHopInUse
 
boolean myPseudoNoiseInUse
 
boolean myTimeHopInUse
 

Detailed Description

A simulation transmitter object.

Constructor & Destructor Documentation

com.mak.vrlj.object.RadioTransmitter.RadioTransmitter ( EmbeddedIdentifier  id)
inline

Member Function Documentation

static void com.mak.vrlj.object.RadioTransmitter.addListener ( ExerciseConnection  exConn,
ObjectListener< ObjectIdentifier, RadioTransmitter listener 
)
inlinestatic
boolean com.mak.vrlj.object.RadioTransmitter.equals ( Object  obj)
inline
byte [] com.mak.vrlj.object.RadioTransmitter.getAntennaPatternParameters ( )
inline

Get the Antenna Pattern Parameters of the radio.

Returns
the Antenna Pattern Parameters of the radio

References com.mak.vrlj.object.RadioTransmitter.myAntennaPatternParameters.

AntennaPatternType com.mak.vrlj.object.RadioTransmitter.getAntennaPatternType ( )
inline

Get the AntennaPatternType of the radio.

Returns
the AntennaPatternType of the radio

References com.mak.vrlj.object.RadioTransmitter.myAntennaPatternType.

String com.mak.vrlj.object.RadioTransmitter.getClassName ( )
inlinevirtual

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

Implements com.mak.vrlj.object.EmbeddedSystem.

References com.mak.vrlj.object.RadioTransmitter.NAME.

short com.mak.vrlj.object.RadioTransmitter.getCryptoKey ( )
inline

Get the Crypto Key of the radio.

Returns
the Crypto Key of the radio

References com.mak.vrlj.object.RadioTransmitter.myCryptoKey.

CryptoMode com.mak.vrlj.object.RadioTransmitter.getCryptoMode ( )
inline

Get the CryptoMode of the radio.

Returns
the CryptoMode of the radio

References com.mak.vrlj.object.RadioTransmitter.myCryptoMode.

CryptoSystem com.mak.vrlj.object.RadioTransmitter.getCryptoSystem ( )
inline

Get the CryptoSystem of the radio.

Returns
the CryptoSystem of the radio

References com.mak.vrlj.object.RadioTransmitter.myCryptoSystem.

boolean com.mak.vrlj.object.RadioTransmitter.getFreqHopInUse ( )
inline
Returns
if the frequency hop is in use

References com.mak.vrlj.object.RadioTransmitter.myFreqHopInUse.

long com.mak.vrlj.object.RadioTransmitter.getFrequency ( )
inline

Get the Frequency of the radio.

Returns
the Frequency of the radio

References com.mak.vrlj.object.RadioTransmitter.myFrequency.

InputSource com.mak.vrlj.object.RadioTransmitter.getInputSource ( )
inline

Get the InputSource of the radio.

Returns
the InputSource of the radio

References com.mak.vrlj.object.RadioTransmitter.myInputSource.

byte [] com.mak.vrlj.object.RadioTransmitter.getModulationParameters ( )
inline

Get the Modulation Parameters of the radio.

Returns
the Modulation Parameters of the radio

References com.mak.vrlj.object.RadioTransmitter.myModulationParameters.

ModulationType com.mak.vrlj.object.RadioTransmitter.getModulationType ( )
inline

Get the ModulationType of the radio.

Returns
the ModulationType of the radio

References com.mak.vrlj.object.RadioTransmitter.myModulationType.

float com.mak.vrlj.object.RadioTransmitter.getPower ( )
inline

Get the Power of the radio.

Returns
the Power of the radio

References com.mak.vrlj.object.RadioTransmitter.myPower.

boolean com.mak.vrlj.object.RadioTransmitter.getPseudoNoiseInUse ( )
inline
Returns
if the pseudo noise is in use

References com.mak.vrlj.object.RadioTransmitter.myPseudoNoiseInUse.

EntityType com.mak.vrlj.object.RadioTransmitter.getRadioEntityType ( )
inline

Get the EntityType of this transmitter.

Returns
the EntityType of this transmitter.

References com.mak.vrlj.object.RadioTransmitter.myRadioEntityType.

ConstVector3f com.mak.vrlj.object.RadioTransmitter.getRelativeAntennaLocation ( )
inline

Get the relative location of the radio antenna.

In geocentric coordinates. relative to the parent entity.

Returns
the relative location of the radio antenna

References com.mak.vrlj.object.RadioTransmitter.myRelativeAntennaLocation.

boolean com.mak.vrlj.object.RadioTransmitter.getTimeHopInUse ( )
inline
Returns
if the time hop is in use

References com.mak.vrlj.object.RadioTransmitter.myTimeHopInUse.

float com.mak.vrlj.object.RadioTransmitter.getTransmitBandwidth ( )
inline

Get the TransmitBandwidth of the radio.

Returns
the TransmitBandwidth of the radio

References com.mak.vrlj.object.RadioTransmitter.myTransmitBandwidth.

TransmitState com.mak.vrlj.object.RadioTransmitter.getTransmitState ( )
inline

Get the TransmitState of the radio.

Returns
the TransmitState of the radio

References com.mak.vrlj.object.RadioTransmitter.myTransmitState.

ConstVector3d com.mak.vrlj.object.RadioTransmitter.getWorldAntennaLocation ( )
inline

Get the absolute location of the radio antenna.

In geocentric coordinates.

Returns
the absolute location of the radio antenna

References com.mak.vrlj.object.RadioTransmitter.myWorldAntennaLocation.

int com.mak.vrlj.object.RadioTransmitter.hashCode ( )
inline
static void com.mak.vrlj.object.RadioTransmitter.removeListener ( ExerciseConnection  exConn,
ObjectListener< ObjectIdentifier, RadioTransmitter listener 
)
inlinestatic
void com.mak.vrlj.object.RadioTransmitter.setAntennaPatternParameters ( byte[]  antennaPatternParameters)
inline

Set the Antenna Pattern Parameters of the radio.

Parameters
antennaPatternParametersthe Antenna Pattern Parameters of the radio

References com.mak.vrlj.object.RadioTransmitter.myAntennaPatternParameters.

void com.mak.vrlj.object.RadioTransmitter.setAntennaPatternType ( AntennaPatternType  antennaPatternType)
inline

Set the AntennaPatternType of the radio.

Parameters
antennaPatternTypethe AntennaPatternType of the radio

References com.mak.vrlj.object.RadioTransmitter.myAntennaPatternType.

void com.mak.vrlj.object.RadioTransmitter.setCryptoKey ( short  cryptoKey)
inline

Set the Crypto Key of the radio.

Parameters
cryptoKeythe Crypto Key of the radio

References com.mak.vrlj.object.RadioTransmitter.myCryptoKey.

void com.mak.vrlj.object.RadioTransmitter.setCryptoMode ( CryptoMode  cryptoMode)
inline

Set the CryptoMode of the radio.

Parameters
cryptoModethe CryptoMode of the radio

References com.mak.vrlj.object.RadioTransmitter.myCryptoMode.

void com.mak.vrlj.object.RadioTransmitter.setCryptoSystem ( CryptoSystem  cryptoSystem)
inline

Set the CryptoSystem of the radio.

Parameters
cryptoSystemthe CryptoSystem of the radio

References com.mak.vrlj.object.RadioTransmitter.myCryptoSystem.

void com.mak.vrlj.object.RadioTransmitter.setFreqHopInUse ( boolean  freqHopInUse)
inline
Parameters
freqHopInUseif the frequency hop is in use

References com.mak.vrlj.object.RadioTransmitter.myFreqHopInUse.

void com.mak.vrlj.object.RadioTransmitter.setFrequency ( long  frequency)
inline

Set the Frequency of the radio.

Parameters
frequencythe Frequency of the radio

References com.mak.vrlj.object.RadioTransmitter.myFrequency.

void com.mak.vrlj.object.RadioTransmitter.setInputSource ( InputSource  inputSource)
inline

Set the InputSource of the radio.

Parameters
inputSourcethe InputSource of the radio

References com.mak.vrlj.object.RadioTransmitter.myInputSource.

void com.mak.vrlj.object.RadioTransmitter.setModulationParameters ( byte[]  modulationParameters)
inline

Set the Modulation Parameters of the radio.

Parameters
modulationParametersthe Modulation Parameters of the radio

References com.mak.vrlj.object.RadioTransmitter.myModulationParameters.

void com.mak.vrlj.object.RadioTransmitter.setModulationType ( ModulationType  modulationType)
inline

Set the ModulationType of the radio.

Parameters
modulationTypethe ModulationType of the radio

References com.mak.vrlj.object.RadioTransmitter.myModulationType.

void com.mak.vrlj.object.RadioTransmitter.setPower ( float  power)
inline

Set the Power of the radio.

Parameters
powerthe Power of the radio

References com.mak.vrlj.object.RadioTransmitter.myPower.

void com.mak.vrlj.object.RadioTransmitter.setPseudoNoiseInUse ( boolean  pseudoNoiseInUse)
inline
Parameters
pseudoNoiseInUseif the pseudo noise is in use

References com.mak.vrlj.object.RadioTransmitter.myPseudoNoiseInUse.

void com.mak.vrlj.object.RadioTransmitter.setRadioEntityType ( EntityType  radioEntityType)
inline
Parameters
radioEntityTypethe entity type this transmitter.

References com.mak.vrlj.object.RadioTransmitter.myRadioEntityType.

void com.mak.vrlj.object.RadioTransmitter.setRelativeAntennaLocation ( Vector3f  relativeAntennaLocation)
inline

Set the relative location of the radio antenna.

In geocentric coordinates. relative to the parent entity.

Parameters
relativeAntennaLocationthe relative location of the radio antenna

References com.mak.vrlj.object.RadioTransmitter.myRelativeAntennaLocation.

void com.mak.vrlj.object.RadioTransmitter.setTimeHopInUse ( boolean  timeHopInUse)
inline
Parameters
timeHopInUseif the time hop is in use

References com.mak.vrlj.object.RadioTransmitter.myTimeHopInUse.

void com.mak.vrlj.object.RadioTransmitter.setTransmitBandwidth ( float  transmitBandwidth)
inline

Set the TransmitBandwidth of the radio.

Parameters
transmitBandwidththe TransmitBandwidth of the radio

References com.mak.vrlj.object.RadioTransmitter.myTransmitBandwidth.

void com.mak.vrlj.object.RadioTransmitter.setTransmitState ( TransmitState  state)
inline

Set the TransmitState of the radio.

Parameters
statethe TransmitState of the radio

References com.mak.vrlj.object.RadioTransmitter.myTransmitState.

void com.mak.vrlj.object.RadioTransmitter.setWorldAntennaLocation ( Vector3d  worldLocation)
inline

Set the absolute location of the radio antenna.

In geocentric coordinates.

Parameters
worldLocationthe absolute location of the radio antenna

References com.mak.vrlj.object.RadioTransmitter.myWorldAntennaLocation.

String com.mak.vrlj.object.RadioTransmitter.toString ( )
inline

Member Data Documentation

byte [] com.mak.vrlj.object.RadioTransmitter.myAntennaPatternParameters
private
AntennaPatternType com.mak.vrlj.object.RadioTransmitter.myAntennaPatternType
private
short com.mak.vrlj.object.RadioTransmitter.myCryptoKey
private
CryptoMode com.mak.vrlj.object.RadioTransmitter.myCryptoMode
private
CryptoSystem com.mak.vrlj.object.RadioTransmitter.myCryptoSystem
private
boolean com.mak.vrlj.object.RadioTransmitter.myFreqHopInUse
private
long com.mak.vrlj.object.RadioTransmitter.myFrequency
private
InputSource com.mak.vrlj.object.RadioTransmitter.myInputSource
private
byte [] com.mak.vrlj.object.RadioTransmitter.myModulationParameters
private
ModulationType com.mak.vrlj.object.RadioTransmitter.myModulationType
private
float com.mak.vrlj.object.RadioTransmitter.myPower
private
boolean com.mak.vrlj.object.RadioTransmitter.myPseudoNoiseInUse
private
EntityType com.mak.vrlj.object.RadioTransmitter.myRadioEntityType
private
Vector3f com.mak.vrlj.object.RadioTransmitter.myRelativeAntennaLocation
private
boolean com.mak.vrlj.object.RadioTransmitter.myTimeHopInUse
private
float com.mak.vrlj.object.RadioTransmitter.myTransmitBandwidth
private
TransmitState com.mak.vrlj.object.RadioTransmitter.myTransmitState
private
Vector3d com.mak.vrlj.object.RadioTransmitter.myWorldAntennaLocation
private
final String com.mak.vrlj.object.RadioTransmitter.NAME = "RadioTransmitter"
static

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

Document ID: Generated on Wed Mar 27 02:04:30 EDT 2024 from SVN revision 264570
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)