VR-Link API Documentation for DIS
Public Member Functions | Static Public Member Functions | Protected Attributes
DtRadioTransmitterRepository Class Reference

Instances of DtRadioTransmitterRepository are used to store state information for objects which are radio transmitters. More...

+ Inheritance diagram for DtRadioTransmitterRepository:
+ Collaboration diagram for DtRadioTransmitterRepository:

List of all members.

Public Member Functions

 DtRadioTransmitterRepository ()
 default constructor
virtual ~DtRadioTransmitterRepository ()
 destructor
 DtRadioTransmitterRepository (const DtRadioTransmitterRepository &orig)
 copy constructor
DtRadioTransmitterRepositoryoperator= (const DtRadioTransmitterRepository &orig)
 assignment operator
virtual DtStateRepositoryclone (bool copy) const
 Return a copy/empty object of the same type as this.
virtual void setAntennaPattern (const DtAntennaPatternRecord &rec)
 Set the antenna pattern.
virtual const
DtAntennaPatternRecord
antennaPattern () const
 Get the antenna pattern.
virtual void setAntennaPatternType (DtAntennaPatternType pattern)
 Set the antenna pattern type.
virtual DtAntennaPatternType antennaPatternType () const
 Get the antenna pattern type.
virtual void setCryptoKeyId (DtU16 key)
 Set the crypto key id.
virtual DtU16 cryptoKeyId () const
 Get the crypto key id.
virtual void setCryptoMode (DtCryptoMode mode)
 Set the crypto key mode.
virtual DtCryptoMode cryptoMode () const
 Get the crypto key mode.
virtual void setCryptoSystem (DtRadioCryptoSystem system)
 Set/Get the crypto system.
virtual DtRadioCryptoSystem cryptoSystem () const
virtual void setDetailedModulationType (DtDetailedModulationType modulation)
 Set the detailed modulation.
virtual DtDetailedModulationType detailedModulationType () const
 Get the detailed modulation.
virtual void setFrequency (unsigned long upper, unsigned long lower)
 Set the frequency, either as upper and lower word, or as full 64 bit integer.
virtual void setFrequency (unsigned long freq)
virtual unsigned long frequency (DtLongWordPortion upperLower=DtLowerWord) const
 Get either the upper or lower word of the 64 bit frequency.
virtual void setStreamTag (unsigned long upper, unsigned long lower)
 Set the StreamTag, either as upper and lower word, or as full 64 bit integer.
virtual void setStreamTag (unsigned long st)
virtual unsigned long streamTag (DtLongWordPortion upperLower=DtLowerWord) const
 Get either the upper or lower word of the 64 bit frequency.
virtual void setFrequencyBandwidth (DtFloat32 bandwidth)
 Set the frequency bandwidth.
virtual DtFloat32 frequencyBandwidth () const
 Get the frequency bandwidth.
virtual void setFrequencyHopInUse (bool hopInUse)
 Set the frequency hop in use.
virtual bool frequencyHopInUse () const
 Get the frequency hop in use.
virtual void setInputSource (DtRadioInputSource source)
 Set the input source.
virtual DtRadioInputSource inputSource () const
 Get the input source.
virtual void setModulationParams (const void *networkRepresentation, DtU8 size)
 Set/Get the modulation parameters' network representation.
virtual const void * modulationParamsAddr () const
virtual DtU8 modulationParamsLength () const
virtual void setMajorModulationType (DtRadioMajorModulation modulation)
 Set the major modulation type.
virtual DtRadioMajorModulation majorModulationType () const
 Get the major modulation type.
virtual void setModulationSystemType (DtRadioSystem system)
 Set the modulation system.
virtual DtRadioSystem modulationSystemType () const
 Get the modulation system.
virtual void setPower (DtFloat32 power)
 Set the power.
virtual DtFloat32 power () const
 Get the power.
virtual void setPsuedoNoiseSpectrumInUse (bool inUse)
 Set the Pseudo Noise Spectrum In Use.
virtual bool psuedoNoiseSpectrumInUse () const
 Get the Pseudo Noise Spectrum In Use.
virtual void setPseudoNoiseSpectrumInUse (bool inUse)
 Set the Pseudo Noise Spectrum In Use.
virtual bool pseudoNoiseSpectrumInUse () const
 Get the Pseudo Noise Spectrum In Use.
virtual void setRadioId (unsigned int number)
 Set the Transmitter radio number.
virtual unsigned int radioId () const
 Get the Transmitter radio number.
virtual void setRadioEntityType (const DtRadioEntityType &type)
 Set the radio entity type.
virtual const DtRadioEntityTyperadioEntityType () const
 Get the radio entity type.
virtual void setTimeHopInUse (bool inUse)
 Set the Time Hop In Use.
virtual bool timeHopInUse () const
 Get the Time Hop In Use.
virtual void setTransmitState (DtRadioTransmitState state)
 Set the transmit state.
virtual DtRadioTransmitState transmitState () const
 Get the transmit state.
virtual void setWorldAntennaLoc (const DtVector &location)
 Set the world location.
virtual const DtVectorworldAntennaLoc () const
 Get the world location.
virtual void setRelativeAntennaLoc (const DtVector &location)
 Set the relative location (wrapper around EmbedSysSR member func, for compatibility with DIS transmitter PDU.)
virtual const DtVectorrelativeAntennaLoc () const
 Get the relative location.
virtual void printData () const
 Print data to the DtInfo stream.
virtual void printDataToStream (std::ostream &stream) const
 Print state data to the specified stream.
virtual DtThresholderthresholder ()
virtual const DtThresholderthresholder () const
ModulationParams and SpreadSpectrum Methods

ModulationParams and SpreadSpectrum Methods

These methods deal with the data types in ModulationParams (RPR 1) and SpreadSpectrum (RPR 2), both of which have an attribute called SINCGARSModulationStruct. The SINCGARSModulationStruct used in RPR 2 lack the attributes ClearChannel and StartOfMessage, which were part of the RPR 1 struct, and therefore those methods are not used in RPR 2.

SpreadSpectrum also has the attribute SpreadSpectrumType, which does not exist in ModulationParams. If the SpreadSpectrumType is DtSpreadSpectrumTypeNone, none of the SINCGARSModulationStruct values will be set.

virtual void setSpreadSpectrumType (DtSpreadSpectrumType ty)
 Set the SpreadSpectrumType: DtSpreadSpectrumTypeNone, DtSINCGARSFrequencyHop, or DtJTIDS_MIDS_SpectrumType (the last is used to set the Link16 Transmitter).
virtual DtSpreadSpectrumType spreadSpectrumType () const
 Get the SpreadSpectrumType.
virtual void setFHNetId (DtU16 id)
 Set the FhNetId for the SINCGARSModulationStruct.
virtual DtU16 fHNetId () const
 Get the FhNetId for the SINCGARSModulationStruct.
virtual void setHopSetId (DtU16 id)
 Set/get the HopSetId for the SINCGARSModulationStruct.
virtual DtU16 hopSetId () const
 Set the SpreadSpectrumType: DtSpreadSpectrumTypeNone, DtSINCGARSFrequencyHop, or DtJTIDS_MIDS_SpectrumType (the last is used to set the Link16 Transmitter).
virtual void setLockoutSetId (DtU16 id)
 Set the LockoutSetId for the SINCGARSModulationStruct.
virtual DtU16 lockoutSetId () const
 Get the LockoutSetId for the SINCGARSModulationStruct.
virtual void setTransmissionSecurityKey (DtU16 key)
 Set the TransmissionSecurityKey for the SINCGARSModulationStruct.
virtual DtU16 transmissionSecurityKey () const
 Get the TransmissionSecurityKey for the SINCGARSModulationStruct.
virtual void setFHSynchronizationTimeOffset (DtU32 id)
 Set the FHSSynchronizationTimeOffset for the SINCGARSModulationStruct.
virtual DtU32 fHSynchronizationTimeOffset () const
 Get the FHSSynchronizationTimeOffset for the SINCGARSModulationStruct.
virtual void setClearChannel (DtU8 chan)
 Set the ClearChannel attribute for the SINCGARSModulationStruct (RPR 1 only)
virtual DtU8 clearChannel () const
 Get the ClearChannel attribute for the SINCGARSModulationStruct (RPR 1 only)
virtual void setStartOfMessage (DtStartMessage mess)
 Set the StartOfMessage attribute for the SINCGARSModulationStruct (RPR 1 only)
virtual DtStartMessage startOfMessage () const
 Get the StartOfMessage attribute for the SINCGARSModulationStruct (RPR 1 only)
Link16Transmitter Methods

Link16Transmitter Methods The following functions are used for Link16 compatibility.

They supplement the standard DtRadioTransmitter attributes with those required by the Link16 transmitter object as described in the SISO-STD-002-2006 document. If you want to use Link16, set the SpreadSpectrumType to DtJTIDS_MIDS_SpectrumType; this will allow use of the appropriate attributes.

virtual void setFidelityLevel (DtU16 level)
 Set the Fidelity Level.
virtual DtU16 fidelityLevel () const
 Get the Fidelity Level.
virtual void setCommunicationMode (DtLink16CommunicationMode mode)
 Set the communications mode.
virtual DtLink16CommunicationMode communicationMode () const
 Get the communications mode.
virtual void setPrimaryMode (DtU16 mode)
 Set the primary mode.
virtual DtU16 primaryMode () const
 Get the primary mode.
virtual void setSecondaryMode (DtU16 mode)
 Set the secondary mode.
virtual DtU16 secondaryMode () const
 Get the secondary mode.
virtual void setSynchronizationState (DtU16 val)
 Set the synchronization state.
virtual DtU16 synchronizationState () const
 Get the synchronization state.
virtual void setNetworkSynchronizationId (int val)
 Set the network synchronization ID.
virtual int networkSynchronizationId () const
 Get the network synchronization ID.

Static Public Member Functions

static
DtRadioTransmitterRepository
create ()

Protected Attributes

DtAntennaPatternType myAntennaPatternType
DtU16 myCryptoKeyId
DtCryptoMode myCryptoMode
DtRadioCryptoSystem myCryptoSystem
DtDetailedModulationType myDetailedModulation
unsigned long myFreqHi
unsigned long myFreqLo
DtU32 myStreamTagHi
DtU32 myStreamTagLo
DtFloat32 myFrequencyBandwidth
bool myFrequencyHopInUse
DtRadioInputSource myInputSource
char * myModulationParamsAddr
DtU8 myModulationParamsLength
DtAntennaPatternRecordmyAntPat
DtRadioMajorModulation myMajorModulationType
DtRadioSystem myModulationSystem
DtFloat32 myPower
bool myPseudoNoiseSpectrumInUse
DtU16 myTransmitterRadioNumber
DtRadioEntityType myRadioEntityType
bool myTimeHopInUse
DtRadioTransmitState myTransmitState
DtVector myWorldLocation
DtSpreadSpectrumType mySpreadSpectrumType
DtThresholder myThresholder
DtU16 myFHNetId
DtU16 myHopSetId
DtU16 myLockoutSetId
DtU16 myTransmissionSecurityKey
DtU32 myFHSynchronizationTimeOffset
DtU8 myClearChannel
DtStartMessage myStartOfMessage
DtU16 myFidelityLevel
DtLink16CommunicationMode myCommunicationMode
DtU16 myPrimaryMode
DtU16 mySecondaryMode
DtU16 mySynchronizationState
int myNetworkSynchronizationId

Detailed Description

Instances of DtRadioTransmitterRepository are used to store state information for objects which are radio transmitters.


Constructor & Destructor Documentation

default constructor

destructor

copy constructor


Member Function Documentation

Get the antenna pattern.

Get the antenna pattern type.

virtual DtU8 DtRadioTransmitterRepository::clearChannel ( ) const [virtual]

Get the ClearChannel attribute for the SINCGARSModulationStruct (RPR 1 only)

virtual DtStateRepository* DtRadioTransmitterRepository::clone ( bool  copy) const [virtual]

Return a copy/empty object of the same type as this.

Reimplemented from DtEmbeddedSystemRepository.

Get the communications mode.

Reimplemented from DtEmbeddedSystemRepository.

virtual DtU16 DtRadioTransmitterRepository::cryptoKeyId ( ) const [virtual]

Get the crypto key id.

Get the crypto key mode.

Get the detailed modulation.

virtual DtU16 DtRadioTransmitterRepository::fHNetId ( ) const [virtual]

Get the FhNetId for the SINCGARSModulationStruct.

Get the FHSSynchronizationTimeOffset for the SINCGARSModulationStruct.

Get the Fidelity Level.

virtual unsigned long DtRadioTransmitterRepository::frequency ( DtLongWordPortion  upperLower = DtLowerWord) const [virtual]

Get either the upper or lower word of the 64 bit frequency.

Get the frequency bandwidth.

virtual bool DtRadioTransmitterRepository::frequencyHopInUse ( ) const [virtual]

Get the frequency hop in use.

virtual DtU16 DtRadioTransmitterRepository::hopSetId ( ) const [virtual]

Set the SpreadSpectrumType: DtSpreadSpectrumTypeNone, DtSINCGARSFrequencyHop, or DtJTIDS_MIDS_SpectrumType (the last is used to set the Link16 Transmitter).

Get the input source.

Get the LockoutSetId for the SINCGARSModulationStruct.

Get the major modulation type.

virtual const void* DtRadioTransmitterRepository::modulationParamsAddr ( ) const [virtual]

Get the modulation system.

Get the network synchronization ID.

DtRadioTransmitterRepository& DtRadioTransmitterRepository::operator= ( const DtRadioTransmitterRepository orig)

assignment operator

virtual DtFloat32 DtRadioTransmitterRepository::power ( ) const [virtual]

Get the power.

virtual DtU16 DtRadioTransmitterRepository::primaryMode ( ) const [virtual]

Get the primary mode.

virtual void DtRadioTransmitterRepository::printData ( ) const [virtual]

Print data to the DtInfo stream.

Reimplemented from DtEmbeddedSystemRepository.

virtual void DtRadioTransmitterRepository::printDataToStream ( std::ostream &  stream) const [virtual]

Print state data to the specified stream.

Reimplemented from DtEmbeddedSystemRepository.

Get the Pseudo Noise Spectrum In Use.

Get the Pseudo Noise Spectrum In Use.

Deprecated to fix spelling.

Get the radio entity type.

virtual unsigned int DtRadioTransmitterRepository::radioId ( ) const [virtual]

Get the Transmitter radio number.

Referenced by DtReflectedRadioTransmitter::radioId().

virtual const DtVector& DtRadioTransmitterRepository::relativeAntennaLoc ( ) const [virtual]

Get the relative location.

Get the secondary mode.

Set the antenna pattern.

Set the antenna pattern type.

virtual void DtRadioTransmitterRepository::setClearChannel ( DtU8  chan) [virtual]

Set the ClearChannel attribute for the SINCGARSModulationStruct (RPR 1 only)

Set the communications mode.

This information is not sent across the network, but is used to set other transmitter parameters, such as frequency, bandwidth, and spread spectrum type.

virtual void DtRadioTransmitterRepository::setCryptoKeyId ( DtU16  key) [virtual]

Set the crypto key id.

Set the crypto key mode.

Set/Get the crypto system.

Set the detailed modulation.

virtual void DtRadioTransmitterRepository::setFHNetId ( DtU16  id) [virtual]

Set the FhNetId for the SINCGARSModulationStruct.

Set the FHSSynchronizationTimeOffset for the SINCGARSModulationStruct.

virtual void DtRadioTransmitterRepository::setFidelityLevel ( DtU16  level) [virtual]

Set the Fidelity Level.

virtual void DtRadioTransmitterRepository::setFrequency ( unsigned long  upper,
unsigned long  lower 
) [virtual]

Set the frequency, either as upper and lower word, or as full 64 bit integer.

virtual void DtRadioTransmitterRepository::setFrequency ( unsigned long  freq) [virtual]
virtual void DtRadioTransmitterRepository::setFrequencyBandwidth ( DtFloat32  bandwidth) [virtual]

Set the frequency bandwidth.

virtual void DtRadioTransmitterRepository::setFrequencyHopInUse ( bool  hopInUse) [virtual]

Set the frequency hop in use.

virtual void DtRadioTransmitterRepository::setHopSetId ( DtU16  id) [virtual]

Set/get the HopSetId for the SINCGARSModulationStruct.

Set the input source.

virtual void DtRadioTransmitterRepository::setLockoutSetId ( DtU16  id) [virtual]

Set the LockoutSetId for the SINCGARSModulationStruct.

Set the major modulation type.

virtual void DtRadioTransmitterRepository::setModulationParams ( const void *  networkRepresentation,
DtU8  size 
) [virtual]

Set/Get the modulation parameters' network representation.

Set the modulation system.

virtual void DtRadioTransmitterRepository::setNetworkSynchronizationId ( int  val) [virtual]

Set the network synchronization ID.

virtual void DtRadioTransmitterRepository::setPower ( DtFloat32  power) [virtual]

Set the power.

virtual void DtRadioTransmitterRepository::setPrimaryMode ( DtU16  mode) [virtual]

Set the primary mode.

virtual void DtRadioTransmitterRepository::setPseudoNoiseSpectrumInUse ( bool  inUse) [virtual]

Set the Pseudo Noise Spectrum In Use.

virtual void DtRadioTransmitterRepository::setPsuedoNoiseSpectrumInUse ( bool  inUse) [virtual]

Set the Pseudo Noise Spectrum In Use.

Deprecated to fix spelling.

virtual void DtRadioTransmitterRepository::setRadioEntityType ( const DtRadioEntityType type) [virtual]

Set the radio entity type.

virtual void DtRadioTransmitterRepository::setRadioId ( unsigned int  number) [virtual]

Set the Transmitter radio number.

virtual void DtRadioTransmitterRepository::setRelativeAntennaLoc ( const DtVector location) [virtual]

Set the relative location (wrapper around EmbedSysSR member func, for compatibility with DIS transmitter PDU.)

virtual void DtRadioTransmitterRepository::setSecondaryMode ( DtU16  mode) [virtual]

Set the secondary mode.

Set the SpreadSpectrumType: DtSpreadSpectrumTypeNone, DtSINCGARSFrequencyHop, or DtJTIDS_MIDS_SpectrumType (the last is used to set the Link16 Transmitter).

Set the StartOfMessage attribute for the SINCGARSModulationStruct (RPR 1 only)

virtual void DtRadioTransmitterRepository::setStreamTag ( unsigned long  upper,
unsigned long  lower 
) [virtual]

Set the StreamTag, either as upper and lower word, or as full 64 bit integer.

virtual void DtRadioTransmitterRepository::setStreamTag ( unsigned long  st) [virtual]

Set the synchronization state.

virtual void DtRadioTransmitterRepository::setTimeHopInUse ( bool  inUse) [virtual]

Set the Time Hop In Use.

Set the TransmissionSecurityKey for the SINCGARSModulationStruct.

Set the transmit state.

virtual void DtRadioTransmitterRepository::setWorldAntennaLoc ( const DtVector location) [virtual]

Set the world location.

Get the SpreadSpectrumType.

Get the StartOfMessage attribute for the SINCGARSModulationStruct (RPR 1 only)

virtual unsigned long DtRadioTransmitterRepository::streamTag ( DtLongWordPortion  upperLower = DtLowerWord) const [virtual]

Get either the upper or lower word of the 64 bit frequency.

Get the synchronization state.

virtual const DtThresholder& DtRadioTransmitterRepository::thresholder ( ) const [virtual]
virtual bool DtRadioTransmitterRepository::timeHopInUse ( ) const [virtual]

Get the Time Hop In Use.

Get the TransmissionSecurityKey for the SINCGARSModulationStruct.

Get the transmit state.

virtual const DtVector& DtRadioTransmitterRepository::worldAntennaLoc ( ) const [virtual]

Get the world location.


Member Data Documentation

unsigned long DtRadioTransmitterRepository::myFreqHi [protected]
unsigned long DtRadioTransmitterRepository::myFreqLo [protected]

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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)