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.
 RadioTransmitter (EmbeddedIdentifier id, RadioTransmitter transmitter)
 Create a new transmitter by copying an existing transmitter.
boolean equals (Object obj)
byte[] getAntennaPatternParameters ()
 Get the Antenna Pattern Parameters of the radio.
AntennaPatternType getAntennaPatternType ()
 Get the AntennaPatternType of the radio.
String getClassName ()
 Get the name of the simulation object class for Entity objects.
short getCryptoKey ()
 Get the Crypto Key of the radio.
CryptoMode getCryptoMode ()
 Get the CryptoMode of the radio.
CryptoSystem getCryptoSystem ()
 Get the CryptoSystem of the radio.
EntityIdentifier getEntityIdentifier ()
 Get the EntityIdentifier which links to the parent entity of this transmitter.
String getHostObjectIdentifier ()
boolean getFreqHopInUse ()
long getFrequency ()
 Get the Frequency of the radio.
EmbeddedIdentifier getGlobalObjectDesignator ()
InputSource getInputSource ()
 Get the InputSource of the radio.
byte[] getModulationParameters ()
 Get the Modulation Parameters of the radio.
ModulationType getModulationType ()
 Get the ModulationType of the radio.
float getPower ()
 Get the Power of the radio.
boolean getPseudoNoiseInUse ()
EntityType getRadioEntityType ()
 Get the EntityType of this transmitter.
short getRadioId ()
 Get the identifier for this transmitter.
ConstVector3f getRelativeAntennaLocation ()
 Get the relative location of the radio antenna.
boolean getTimeHopInUse ()
float getTransmitBandwidth ()
 Get the TransmitBandwidth of the radio.
TransmitState getTransmitState ()
 Get the TransmitState of the radio.
ConstVector3d getWorldAntennaLocation ()
 Get the absolute location of the radio antenna.
int hashCode ()
void setHostObjectIdentifier (String hostObject)
 Set the Hosting Object if using HLA.
void setAntennaPatternParameters (byte[] antennaPatternParameters)
 Set the Antenna Pattern Parameters of the radio.
void setAntennaPatternType (AntennaPatternType antennaPatternType)
 Set the AntennaPatternType of the radio.
void setCryptoKey (short cryptoKey)
 Set the Crypto Key of the radio.
void setCryptoMode (CryptoMode cryptoMode)
 Set the CryptoMode of the radio.
void setCryptoSystem (CryptoSystem cryptoSystem)
 Set the CryptoSystem of the radio.
void setFreqHopInUse (boolean freqHopInUse)
void setFrequency (long frequency)
 Set the Frequency of the radio.
void setInputSource (InputSource inputSource)
 Set the InputSource of the radio.
void setModulationParameters (byte[] modulationParameters)
 Set the Modulation Parameters of the radio.
void setModulationType (ModulationType modulationType)
 Set the ModulationType of the radio.
void setPower (float power)
 Set the Power of the radio.
void setPseudoNoiseInUse (boolean pseudoNoiseInUse)
void setRadioEntityType (EntityType radioEntityType)
void setRelativeAntennaLocation (ConstVector3f relativeAntennaLocation)
 Set the relative location of the radio antenna.
void setTimeHopInUse (boolean timeHopInUse)
void setTransmitBandwidth (float transmitBandwidth)
 Set the TransmitBandwidth of the radio.
void setTransmitState (TransmitState state)
 Set the TransmitState of the radio.
void setWorldAntennaLocation (ConstVector3d worldLocation)
 Set the absolute location of the radio antenna.
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.

Private Attributes

final EmbeddedIdentifier myIdentifier
final EntityIdentifier myEntityId
String myHostObjectIdentifier
final short myRadioId
EntityType myRadioEntityType
TransmitState myTransmitState
InputSource myInputSource
ConstVector3d myWorldAntennaLocation
ConstVector3f 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

Create a simulation object.

Parameters
nameunique name for this simulation object.

References com.mak.vrlj.datatype.CryptoMode.BASEBAND, com.mak.vrlj.object.RadioTransmitter.myAntennaPatternParameters, com.mak.vrlj.object.RadioTransmitter.myAntennaPatternType, com.mak.vrlj.object.RadioTransmitter.myCryptoKey, com.mak.vrlj.object.RadioTransmitter.myCryptoMode, com.mak.vrlj.object.RadioTransmitter.myCryptoSystem, com.mak.vrlj.object.RadioTransmitter.myEntityId, com.mak.vrlj.object.RadioTransmitter.myFreqHopInUse, com.mak.vrlj.object.RadioTransmitter.myFrequency, com.mak.vrlj.object.RadioTransmitter.myHostObjectIdentifier, com.mak.vrlj.object.RadioTransmitter.myIdentifier, com.mak.vrlj.object.RadioTransmitter.myInputSource, com.mak.vrlj.object.RadioTransmitter.myModulationParameters, com.mak.vrlj.object.RadioTransmitter.myModulationType, com.mak.vrlj.object.RadioTransmitter.myPower, com.mak.vrlj.object.RadioTransmitter.myPseudoNoiseInUse, com.mak.vrlj.object.RadioTransmitter.myRadioEntityType, com.mak.vrlj.object.RadioTransmitter.myRadioId, com.mak.vrlj.object.RadioTransmitter.myRelativeAntennaLocation, com.mak.vrlj.object.RadioTransmitter.myTimeHopInUse, com.mak.vrlj.object.RadioTransmitter.myTransmitBandwidth, com.mak.vrlj.object.RadioTransmitter.myTransmitState, com.mak.vrlj.object.RadioTransmitter.myWorldAntennaLocation, com.mak.vrlj.datatype.TransmitState.OFF, com.mak.vrlj.datatype.AntennaPatternType.OMNIDIRECTIONAL, com.mak.vrlj.datatype.CryptoSystem.OTHER, and com.mak.vrlj.datatype.InputSource.OTHER.

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

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

Create a new transmitter by copying an existing transmitter.

Parameters
nameunique name for this simulation object.
entityan entity which will be copied into the new entity during initialization.

References com.mak.vrlj.object.RadioTransmitter.getAntennaPatternParameters(), com.mak.vrlj.object.RadioTransmitter.getAntennaPatternType(), com.mak.vrlj.object.RadioTransmitter.getCryptoKey(), com.mak.vrlj.object.RadioTransmitter.getCryptoMode(), com.mak.vrlj.object.RadioTransmitter.getCryptoSystem(), com.mak.vrlj.object.RadioTransmitter.getFreqHopInUse(), com.mak.vrlj.object.RadioTransmitter.getFrequency(), com.mak.vrlj.object.RadioTransmitter.getHostObjectIdentifier(), com.mak.vrlj.object.RadioTransmitter.getInputSource(), com.mak.vrlj.object.RadioTransmitter.getModulationParameters(), com.mak.vrlj.object.RadioTransmitter.getModulationType(), com.mak.vrlj.object.RadioTransmitter.getPower(), com.mak.vrlj.object.RadioTransmitter.getPseudoNoiseInUse(), com.mak.vrlj.object.RadioTransmitter.getRadioEntityType(), com.mak.vrlj.object.RadioTransmitter.getRelativeAntennaLocation(), com.mak.vrlj.object.RadioTransmitter.getTimeHopInUse(), com.mak.vrlj.object.RadioTransmitter.getTransmitBandwidth(), com.mak.vrlj.object.RadioTransmitter.getTransmitState(), com.mak.vrlj.object.RadioTransmitter.getWorldAntennaLocation(), com.mak.vrlj.object.RadioTransmitter.myAntennaPatternParameters, com.mak.vrlj.object.RadioTransmitter.myAntennaPatternType, com.mak.vrlj.object.RadioTransmitter.myCryptoKey, com.mak.vrlj.object.RadioTransmitter.myCryptoMode, com.mak.vrlj.object.RadioTransmitter.myCryptoSystem, com.mak.vrlj.object.RadioTransmitter.myEntityId, com.mak.vrlj.object.RadioTransmitter.myFreqHopInUse, com.mak.vrlj.object.RadioTransmitter.myFrequency, com.mak.vrlj.object.RadioTransmitter.myHostObjectIdentifier, com.mak.vrlj.object.RadioTransmitter.myIdentifier, com.mak.vrlj.object.RadioTransmitter.myInputSource, com.mak.vrlj.object.RadioTransmitter.myModulationParameters, com.mak.vrlj.object.RadioTransmitter.myModulationType, com.mak.vrlj.object.RadioTransmitter.myPower, com.mak.vrlj.object.RadioTransmitter.myPseudoNoiseInUse, com.mak.vrlj.object.RadioTransmitter.myRadioEntityType, com.mak.vrlj.object.RadioTransmitter.myRadioId, com.mak.vrlj.object.RadioTransmitter.myRelativeAntennaLocation, com.mak.vrlj.object.RadioTransmitter.myTimeHopInUse, com.mak.vrlj.object.RadioTransmitter.myTransmitBandwidth, com.mak.vrlj.object.RadioTransmitter.myTransmitState, com.mak.vrlj.object.RadioTransmitter.myWorldAntennaLocation, and com.mak.vrlj.datatype.EntityType.toString().

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.

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

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

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

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.

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

CryptoMode com.mak.vrlj.object.RadioTransmitter.getCryptoMode ( )
inline
CryptoSystem com.mak.vrlj.object.RadioTransmitter.getCryptoSystem ( )
inline
EntityIdentifier com.mak.vrlj.object.RadioTransmitter.getEntityIdentifier ( )
inline

Get the EntityIdentifier which links to the parent entity of this transmitter.

Returns
EntityIdentifier of the parent entity.

References com.mak.vrlj.object.RadioTransmitter.myEntityId.

boolean com.mak.vrlj.object.RadioTransmitter.getFreqHopInUse ( )
inline
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.

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

EmbeddedIdentifier com.mak.vrlj.object.RadioTransmitter.getGlobalObjectDesignator ( )
inline
String com.mak.vrlj.object.RadioTransmitter.getHostObjectIdentifier ( )
inline
Returns
the Host Object Identifier if using HLA

References com.mak.vrlj.object.RadioTransmitter.myHostObjectIdentifier.

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

InputSource com.mak.vrlj.object.RadioTransmitter.getInputSource ( )
inline
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.

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

ModulationType com.mak.vrlj.object.RadioTransmitter.getModulationType ( )
inline
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.

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

boolean com.mak.vrlj.object.RadioTransmitter.getPseudoNoiseInUse ( )
inline
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.

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

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

Get the identifier for this transmitter.

Should be unique for each entity.

Returns
the identifier for this transmitter

References com.mak.vrlj.object.RadioTransmitter.myRadioId.

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.

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

boolean com.mak.vrlj.object.RadioTransmitter.getTimeHopInUse ( )
inline
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.

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

TransmitState com.mak.vrlj.object.RadioTransmitter.getTransmitState ( )
inline
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.

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

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
theAntenna 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
theAntennaPatternType 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
theCrypto 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
theCryptoMode 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
theCryptoSystem of the radio

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

void com.mak.vrlj.object.RadioTransmitter.setFreqHopInUse ( boolean  freqHopInUse)
inline
Parameters
ifthe 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
theFrequency of the radio

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

void com.mak.vrlj.object.RadioTransmitter.setHostObjectIdentifier ( String  hostObject)
inline

Set the Hosting Object if using HLA.

Parameters
theHosting Object if using HLA

References com.mak.vrlj.object.RadioTransmitter.myHostObjectIdentifier.

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

Set the InputSource of the radio.

Parameters
theInputSource 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
theModulation 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
theModulationType 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
thePower of the radio

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

void com.mak.vrlj.object.RadioTransmitter.setPseudoNoiseInUse ( boolean  pseudoNoiseInUse)
inline
Parameters
ifthe 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 ( ConstVector3f  relativeAntennaLocation)
inline

Set the relative location of the radio antenna.

In geocentric coordinates. relative to the parent entity.

Parameters
therelative location of the radio antenna

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

void com.mak.vrlj.object.RadioTransmitter.setTimeHopInUse ( boolean  timeHopInUse)
inline
Parameters
ifthe 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
theTransmitBandwidth 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
theTransmitState of the radio

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

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

Set the absolute location of the radio antenna.

In geocentric coordinates.

Parameters
theabsolute 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
final EntityIdentifier com.mak.vrlj.object.RadioTransmitter.myEntityId
private
boolean com.mak.vrlj.object.RadioTransmitter.myFreqHopInUse
private
long com.mak.vrlj.object.RadioTransmitter.myFrequency
private
String com.mak.vrlj.object.RadioTransmitter.myHostObjectIdentifier
private
final EmbeddedIdentifier com.mak.vrlj.object.RadioTransmitter.myIdentifier
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
final short com.mak.vrlj.object.RadioTransmitter.myRadioId
private
ConstVector3f 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
ConstVector3d 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 Mon Apr 8 04:49:21 EDT 2019 from SVN revision 197403
Copyright © 2005-2016 VT MÄK. All Rights Reserved (www.mak.com)