Base transmitter component class. More...

#include <TransmitterComponent.h>

Inheritance diagram for TransmitterComponent:

Public Member Functions
	TransmitterComponent (const std::string &name="TX", int index=1, RadioHandler *parent=NULL, bool debug=false, double freqRangeMin=20e6, double freqRangeMax=6000e6, double freqRes=1e6, double freqUnits=1e6, double attRangeMin=0.0, double attRangeMax=10.0, double attRes=1.0, int numToneGen=0, int toneGenIndexBase=1, double frequency=900e6, double attenuation=0.0)
	Constructs a TransmitterComponent object. More...

virtual	~TransmitterComponent ()
	Destroys a TransmitterComponent object.

	TransmitterComponent (const TransmitterComponent &other)
	Copies a TransmitterComponent object. More...

virtual TransmitterComponent &	operator= (const TransmitterComponent &other)
	Assignment operator for TransmitterComponent objects. More...

virtual bool	enable (bool enabled=true)
	Enables this component. More...

virtual bool	setConfiguration (ConfigurationDict &cfg)
	Sets the configuration dictionary for this component. More...

virtual void	queryConfiguration ()
	Tells the component to query its hardware configuration in order to create its configuration dictionary.

virtual double	getFrequency () const
	Gets the transmitter center frequency. More...

virtual bool	setFrequency (double freq)
	Sets the transmitter center frequency. More...

virtual double	getAttenuation () const
	Gets the attenuation. More...

virtual bool	setAttenuation (double atten)
	Sets the attenuation. More...

virtual BasicDoubleList	getFrequencyRange () const
	Gets the transmitter center frequency range. More...

virtual double	getFrequencyRes () const
	Gets the transmitter center frequency resolution. More...

virtual double	getFrequencyUnit () const
	Gets the transmitter center frequency units. More...

virtual BasicDoubleList	getAttenuationRange () const
	Gets the attenuation range. More...

virtual double	getAttenuationRes () const
	Gets the attenuation resolution. More...

virtual bool	supportsCW () const
	Gets whether the transmitter supports CW tone generation. More...

virtual int	getCWNum () const
	Gets the number of CW tone generators associated with this transmitter. More...

virtual BasicIntList	getCWIndexRange () const
	Gets the range of indices for CW tone generators. More...

virtual BasicDoubleList	getCWFrequencyRange () const
	Gets the CW frequency range. More...

virtual double	getCWFrequencyRes () const
	Gets the CW frequency resolution. More...

virtual BasicDoubleList	getCWAmplitudeRange () const
	Gets the CW amplitude range. More...

virtual double	getCWAmplitudeRes () const
	Gets the CW amplitude resolution. More...

virtual BasicDoubleList	getCWPhaseRange () const
	Gets the CW phase range. More...

virtual double	getCWPhaseRes () const
	Gets the CW phase resolution. More...

virtual bool	supportsCWSweep () const
	Gets whether the transmitter supports CW tone sweeping. More...

virtual BasicDoubleList	getCWSweepStartRange () const
	Gets the CW start frequency range. More...

virtual double	getCWSweepStartRes () const
	Gets the CW start frequency resolution. More...

virtual BasicDoubleList	getCWSweepStopRange () const
	Gets the CW stop frequency range. More...

virtual double	getCWSweepStopRes () const
	Gets the CW stop frequency resolution. More...

virtual BasicDoubleList	getCWSweepStepRange () const
	Gets the CW frequency step range. More...

virtual double	getCWSweepStepRes () const
	Gets the CW frequency step resolution. More...

virtual BasicDoubleList	getCWSweepDwellRange () const
	Gets the CW dwell time range. More...

virtual double	getCWSweepDwellRes () const
	Gets the CW dwell time resolution. More...

virtual bool	enableCW (int index, bool enabled=true)
	Enables a given CW tone generator. More...

virtual bool	disableCW (int index)
	Disables a given CW tone generator. More...

virtual ConfigurationDict	getCWConfiguration (int index) const
	Gets the configuration for a given CW tone generator. More...

virtual bool	setCWConfiguration (int index, ConfigurationDict &cfg)
	Sets the configuration dictionary for a given CW tone generator. More...

virtual double	getCWFrequency (int index) const
	Gets the constant frequency for a given CW tone generator. More...

virtual bool	setCWFrequency (int index, double freq)
	Sets the constant frequency for a given CW tone generator. More...

virtual double	getCWAmplitude (int index) const
	Gets the signal amplitude for a given CW tone generator. More...

virtual bool	setCWAmplitude (int index, double amp)
	Sets the signal amplitude for a given CW tone generator. More...

virtual double	getCWPhase (int index) const
	Gets the signal phase for a given CW tone generator. More...

virtual bool	setCWPhase (int index, double phase)
	Sets the signal phase for a given CW tone generator. More...

virtual bool	supportsCWSweep (int index) const
	Gets whether or not a given CW tone generator supports signal sweeps. More...

virtual double	getCWSweepStartFrequency (int index) const
	Gets the start frequency for a signal sweep for a given CW tone generator. More...

virtual double	getCWSweepStopFrequency (int index) const
	Gets the stop frequency for a signal sweep for a given CW tone generator. More...

virtual double	getCWSweepFrequencyStep (int index) const
	Gets the frequency step for a signal sweep for a given CW tone generator. More...

virtual double	getCWSweepDwellTime (int index) const
	Gets the dwell time for a signal sweep for a given CW tone generator. More...

virtual bool	setCWFrequencySweep (int index, double start, double stop, double step, double dwell)
	Sets the parameters for a frequency sweep for a given CW tone generator. More...

virtual int	getIndex () const
	Gets the index number of the component. More...

virtual void	setIndex (int index)
	Sets the index number of the component. More...

virtual RadioHandler *	getParent () const
	Gets the "parent" radio handler for this component. More...

virtual void	setParent (RadioHandler *parent)
	Sets the "parent" radio handler for this component. More...

virtual bool	disable ()
	Disables this component. More...

virtual bool	isEnabled () const
	Gets whether or not the component is enabled. More...

virtual std::string	getName () const
	Gets the name of the configurable object. More...

virtual void	setName (const std::string &name)
	Sets the name of the configurable object. More...

virtual ConfigurationDict	getConfiguration () const
	Gets the configuration dictionary for this object. More...

virtual ConfigString	getConfigurationValue (const std::string &key) const
	Gets a named configuration value as a string. More...

virtual bool	getConfigurationValueAsBool (const std::string &key) const
	Gets a named configuration value as a Boolean. More...

virtual int	getConfigurationValueAsInt (const std::string &key) const
	Gets a named configuration value as an integer value. More...

virtual unsigned int	getConfigurationValueAsUInt (const std::string &key) const
	Gets a named configuration value as an unsigned integer value. More...

virtual double	getConfigurationValueAsDbl (const std::string &key) const
	Gets a named configuration value as a double value. More...

virtual bool	setConfigurationValue (const std::string &key, const std::string &value)
	Sets a named configuration value to a string. More...

virtual bool	setConfigurationValueToBool (const std::string &key, const bool value)
	Sets a named configuration value to a Boolean. More...

virtual bool	setConfigurationValueToInt (const std::string &key, const int value)
	Sets a named configuration value to an integer value. More...

virtual bool	setConfigurationValueToUInt (const std::string &key, const unsigned int value)
	Sets a named configuration value to an unsigned integer value. More...

virtual bool	setConfigurationValueToDbl (const std::string &key, const double value)
	Sets a named configuration value to a double value. More...

virtual void	setDebugName (const std::string &debug_name)
	Sets the debug name for this object. More...

virtual void	setDebugFile (FILE *debug_fp)
	Sets the debug file pointer for this object. More...

virtual void	setDebugTimeFormat (const std::string &debug_timefmt)
	Sets the debug time format for this object. More...

virtual int	debug (const char *format,...)
	Outputs debug information. More...

virtual const char *	debugBool (bool x)
	Gets a debug output string for a Boolean value. More...

virtual bool	isDebug () const
	Gets whether this object produces debug output. More...

virtual std::string	getDebugName () const
	Gets the debug name for this object. More...

virtual std::string	rawString (const std::string &data)
	Gets a "raw" string representation of a given data string. More...

Protected Member Functions
virtual void	initConfigurationDict ()
	Initializes the configuration dictionary, defining the allowed keys.

virtual void	updateConfigurationDict ()
	Updates the configuration dictionary from component settings.

virtual bool	executeEnableQuery (int index, bool &enabled)
	Executes the tuner enabled query command. More...

virtual bool	executeFreqQuery (int index, double &freq)
	Executes the tuner frequency query command. More...

virtual bool	executeAttenQuery (int index, double &atten)
	Executes the tuner attenuation query command. More...

virtual bool	executeEnableCommand (int index, bool &enabled)
	Executes the tuner enable command. More...

virtual bool	executeFreqCommand (int index, double &freq)
	Executes the tuner frequency set command. More...

virtual bool	executeAttenCommand (int index, double &atten)
	Executes the tuner attenuation set command. More...

virtual ConfigurationDict	normalizedConfigurationDict (const ConfigurationDict &cfg)
	Normalizes an incoming configuration dictionary. More...

virtual std::string	normalizedBool (const std::string &val)
	Normalizes a Boolean string value. More...

virtual void	dumpConfiguration ()
	Dumps this object's configuration dictionary to debug output.

Detailed Description

Base transmitter component class.

A radio handler object maintains one transmitter component object per transmitter on the radio.

Configuration dictionary elements:

"enable": Whether or not this transmitter is enabled [Boolean/integer/string]
"frequency": Tuned frequency (Hz) [double/string]
"attenuation": Attenuation (dB) [double/string]

Definition at line 45 of file TransmitterComponent.h.

Constructor & Destructor Documentation

◆ TransmitterComponent() [1/2]

TransmitterComponent	(	const std::string &	name = `"TX"`,
		int	index = `1`,
		RadioHandler *	parent = `NULL`,
		bool	debug = `false`,
		double	freqRangeMin = `20e6`,
		double	freqRangeMax = `6000e6`,
		double	freqRes = `1e6`,
		double	freqUnits = `1e6`,
		double	attRangeMin = `0.0`,
		double	attRangeMax = `10.0`,
		double	attRes = `1.0`,
		int	numToneGen = `0`,
		int	toneGenIndexBase = `1`,
		double	frequency = `900e6`,
		double	attenuation = `0.0`
	)

Constructs a TransmitterComponent object.

Parameters

name	The name of this component.
index	The index number of this component.
parent	A pointer to the RadioHandler object that "owns" this component.
debug	Whether the component supports debug output.
freqRangeMin	Minimum tunable frequency (Hz).
freqRangeMax	Maximum tunable frequency (Hz).
freqRes	Tunable frequency resolution (Hz).
freqUnits	Tunable frequency units (Hz).
attRangeMin	Minimum attenuation (dB).
attRangeMax	Maximum attenuation (dB).
attRes	Attenuation resolution (dB).
numToneGen	Number of CW tone generators associated with this transmitter.
toneGenIndexBase	Number where tone generator index numbers begin.
frequency	Transmitter center frequency (Hz).
attenuation	Transmitter attenuation (dB).

Definition at line 24 of file TransmitterComponent.cpp.

◆ TransmitterComponent() [2/2]

TransmitterComponent ( const TransmitterComponent & other )

Copies a TransmitterComponent object.

Parameters

other The TransmitterComponent object to copy.

Definition at line 66 of file TransmitterComponent.cpp.

Member Function Documentation

◆ debug()

int debug	(	const char *	format,
			...
	)

virtualinherited

Outputs debug information.

This method follows the same semantics as printf(). Output is preceded by a timestamp and the name of the object, if provided.

Parameters

format	The printf()-style format string.
...	Comma-separated list of arguments to print. Note that these need to be arguments that can be supported natively through printf().

Returns: The number of characters outputted.

Definition at line 95 of file Debuggable.cpp.

◆ debugBool()

const char * debugBool ( bool x )

virtualinherited

Gets a debug output string for a Boolean value.

Parameters

x	Boolean value

Returns: A constant string, either "true" or "false".

Definition at line 126 of file Debuggable.cpp.

◆ disable()

bool disable ( )

virtualinherited

Disables this component.

Returns: True if successful, false otherwise.

Definition at line 76 of file RadioComponent.cpp.

◆ disableCW()

bool disableCW ( int index )

virtual

Disables a given CW tone generator.

Parameters

index CW tone generator index.

Returns: True if successful, false otherwise.

Definition at line 423 of file TransmitterComponent.cpp.

◆ enable()

bool enable ( bool enabled = true )

virtual

Enables this component.

Parameters

enabled Whether or not this component should be enabled.

Returns: True if successful, false otherwise.

Reimplemented from RadioComponent.

Definition at line 102 of file TransmitterComponent.cpp.

◆ enableCW()

bool enableCW	(	int	index,
		bool	enabled = `true`
	)

virtual

Enables a given CW tone generator.

Parameters

index	CW tone generator index.
enabled	Whether or not this component should be enabled.

Returns: True if successful, false otherwise.

Definition at line 414 of file TransmitterComponent.cpp.

◆ executeAttenCommand()

bool executeAttenCommand	(	int	index,
		double &	atten
	)

protectedvirtual

Executes the tuner attenuation set command.

Parameters

index	tuner index.
atten	Attenuation (dB).

Returns: True if the command succeeded, false otherwise.

Definition at line 693 of file TransmitterComponent.cpp.

◆ executeAttenQuery()

bool executeAttenQuery	(	int	index,
		double &	atten
	)

protectedvirtual

Executes the tuner attenuation query command.

Note: The return value from this method only indicates if the command succeeded or failed. This method uses reference parameters to return the results of the query.

Parameters

index	tuner index.
atten	Attenuation (dB) (return).

Returns: True if the command succeeded, false otherwise.

Definition at line 631 of file TransmitterComponent.cpp.

◆ executeEnableCommand()

bool executeEnableCommand	(	int	index,
		bool &	enabled
	)

protectedvirtual

Executes the tuner enable command.

Parameters

index	tuner index.
enabled	Whether or not tuner is enabled.

Returns: True if the command succeeded, false otherwise.

Definition at line 654 of file TransmitterComponent.cpp.

◆ executeEnableQuery()

bool executeEnableQuery	(	int	index,
		bool &	enabled
	)

protectedvirtual

Executes the tuner enabled query command.

Note: The return value from this method only indicates if the command succeeded or failed. This method uses reference parameters to return the results of the query.

Parameters

index	tuner index.
enabled	Whether or not tuner is enabled (return).

Returns: True if the command succeeded, false otherwise.

Definition at line 584 of file TransmitterComponent.cpp.

◆ executeFreqCommand()

bool executeFreqCommand	(	int	index,
		double &	freq
	)

protectedvirtual

Executes the tuner frequency set command.

Parameters

index	tuner index.
freq	Tuned frequency (Hz).

Returns: True if the command succeeded, false otherwise.

Definition at line 673 of file TransmitterComponent.cpp.

◆ executeFreqQuery()

bool executeFreqQuery	(	int	index,
		double &	freq
	)

protectedvirtual

Executes the tuner frequency query command.

Note: The return value from this method only indicates if the command succeeded or failed. This method uses reference parameters to return the results of the query.

Parameters

index	tuner index.
freq	Tuned frequency (Hz) (return).

Returns: True if the command succeeded, false otherwise.

Definition at line 608 of file TransmitterComponent.cpp.

◆ getAttenuation()

double getAttenuation ( ) const

virtual

Gets the attenuation.

Returns: The attenuation, in dB.

Definition at line 208 of file TransmitterComponent.cpp.

◆ getAttenuationRange()

BasicDoubleList getAttenuationRange ( ) const

virtual

Gets the attenuation range.

Returns: A list containing the minimum and maximum attenuation values.

Definition at line 247 of file TransmitterComponent.cpp.

◆ getAttenuationRes()

double getAttenuationRes ( ) const

virtual

Gets the attenuation resolution.

Returns: The resolution.

Definition at line 255 of file TransmitterComponent.cpp.

◆ getConfiguration()

ConfigurationDict getConfiguration ( ) const

virtualinherited

Gets the configuration dictionary for this object.

Returns: The configuration dictionary.

Definition at line 93 of file Configurable.cpp.

◆ getConfigurationValue()

ConfigString getConfigurationValue ( const std::string & key ) const

virtualinherited

Gets a named configuration value as a string.

Parameters

key	The key string in the configuration dictionary.

Returns: The value represented by this key. Returns an empty string if the key is not in the configuration dictionary.

Definition at line 98 of file Configurable.cpp.

◆ getConfigurationValueAsBool()

bool getConfigurationValueAsBool ( const std::string & key ) const

virtualinherited

Gets a named configuration value as a Boolean.

Parameters

key	The key string in the configuration dictionary.

Returns: The Boolean value represented by this key. Returns false if the key is not in the configuration dictionary, or cannot be represented as a Boolean.

Definition at line 109 of file Configurable.cpp.

◆ getConfigurationValueAsDbl()

double getConfigurationValueAsDbl ( const std::string & key ) const

virtualinherited

Gets a named configuration value as a double value.

Parameters

key	The key string in the configuration dictionary.

Returns: The double value represented by this key. Returns 0.0 if the key is not in the configuration dictionary, or if the value cannot be represented as a double.

Definition at line 148 of file Configurable.cpp.

◆ getConfigurationValueAsInt()

int getConfigurationValueAsInt ( const std::string & key ) const

virtualinherited

Gets a named configuration value as an integer value.

Parameters

key	The key string in the configuration dictionary.

Returns: The integer value represented by this key. Returns 0 if the key is not in the configuration dictionary, or if the value cannot be represented as an integer.

Definition at line 122 of file Configurable.cpp.

◆ getConfigurationValueAsUInt()

unsigned int getConfigurationValueAsUInt ( const std::string & key ) const

virtualinherited

Gets a named configuration value as an unsigned integer value.

Parameters

key	The key string in the configuration dictionary.

Returns: The integer value represented by this key. Returns 0 if the key is not in the configuration dictionary, or if the value cannot be represented as an integer.

Definition at line 135 of file Configurable.cpp.

◆ getCWAmplitude()

double getCWAmplitude ( int index ) const

virtual

Gets the signal amplitude for a given CW tone generator.

Parameters

index CW tone generator index.

Returns: The signal amplitude, in scale units.

Definition at line 464 of file TransmitterComponent.cpp.

◆ getCWAmplitudeRange()

BasicDoubleList getCWAmplitudeRange ( ) const

virtual

Gets the CW amplitude range.

Returns: A list containing the minimum and maximum amplitude values.

Definition at line 297 of file TransmitterComponent.cpp.

◆ getCWAmplitudeRes()

double getCWAmplitudeRes ( ) const

virtual

Gets the CW amplitude resolution.

Returns: The resolution.

Definition at line 306 of file TransmitterComponent.cpp.

◆ getCWConfiguration()

ConfigurationDict getCWConfiguration ( int index ) const

virtual

Gets the configuration for a given CW tone generator.

Parameters

index CW tone generator index.

Returns: The configuration dictionary.

Definition at line 428 of file TransmitterComponent.cpp.

◆ getCWFrequency()

double getCWFrequency ( int index ) const

virtual

Gets the constant frequency for a given CW tone generator.

Parameters

index CW tone generator index.

Returns: The constant frequency, in Hz.

Definition at line 446 of file TransmitterComponent.cpp.

◆ getCWFrequencyRange()

BasicDoubleList getCWFrequencyRange ( ) const

virtual

Gets the CW frequency range.

Returns: A list containing the minimum and maximum frequencies.

Definition at line 279 of file TransmitterComponent.cpp.

◆ getCWFrequencyRes()

double getCWFrequencyRes ( ) const

virtual

Gets the CW frequency resolution.

Returns: The frequency resolution, in Hz.

Definition at line 288 of file TransmitterComponent.cpp.

◆ getCWIndexRange()

BasicIntList getCWIndexRange ( ) const

virtual

Gets the range of indices for CW tone generators.

Returns: A list containing the generator indices.

Definition at line 270 of file TransmitterComponent.cpp.

◆ getCWNum()

int getCWNum ( ) const

virtual

Gets the number of CW tone generators associated with this transmitter.

Returns: The number of generators.

Definition at line 265 of file TransmitterComponent.cpp.

◆ getCWPhase()

double getCWPhase ( int index ) const

virtual

Gets the signal phase for a given CW tone generator.

Parameters

index CW tone generator index.

Returns: The signal phase, in degrees.

Definition at line 482 of file TransmitterComponent.cpp.

◆ getCWPhaseRange()

BasicDoubleList getCWPhaseRange ( ) const

virtual

Gets the CW phase range.

Returns: A list containing the minimum and maximum phase values.

Definition at line 315 of file TransmitterComponent.cpp.

◆ getCWPhaseRes()

double getCWPhaseRes ( ) const

virtual

Gets the CW phase resolution.

Returns: The resolution.

Definition at line 324 of file TransmitterComponent.cpp.

◆ getCWSweepDwellRange()

BasicDoubleList getCWSweepDwellRange ( ) const

virtual

Gets the CW dwell time range.

Returns: A list containing the minimum and maximum dwell time values.

Definition at line 396 of file TransmitterComponent.cpp.

◆ getCWSweepDwellRes()

double getCWSweepDwellRes ( ) const

virtual

Gets the CW dwell time resolution.

Returns: The resolution.

Definition at line 405 of file TransmitterComponent.cpp.

◆ getCWSweepDwellTime()

double getCWSweepDwellTime ( int index ) const

virtual

Gets the dwell time for a signal sweep for a given CW tone generator.

Parameters

index CW tone generator index.

Returns: The dwell time, in sample clocks.

Definition at line 536 of file TransmitterComponent.cpp.

◆ getCWSweepFrequencyStep()

double getCWSweepFrequencyStep ( int index ) const

virtual

Gets the frequency step for a signal sweep for a given CW tone generator.

Parameters

index CW tone generator index.

Returns: The frequency step, in Hz.

Definition at line 527 of file TransmitterComponent.cpp.

◆ getCWSweepStartFrequency()

double getCWSweepStartFrequency ( int index ) const

virtual

Gets the start frequency for a signal sweep for a given CW tone generator.

Parameters

index CW tone generator index.

Returns: The start frequency, in Hz.

Definition at line 509 of file TransmitterComponent.cpp.

◆ getCWSweepStartRange()

BasicDoubleList getCWSweepStartRange ( ) const

virtual

Gets the CW start frequency range.

Returns: A list containing the minimum and maximum frequency values.

Definition at line 342 of file TransmitterComponent.cpp.

◆ getCWSweepStartRes()

double getCWSweepStartRes ( ) const

virtual

Gets the CW start frequency resolution.

Returns: The resolution.

Definition at line 351 of file TransmitterComponent.cpp.

◆ getCWSweepStepRange()

BasicDoubleList getCWSweepStepRange ( ) const

virtual

Gets the CW frequency step range.

Returns: A list containing the minimum and maximum frequency values.

Definition at line 378 of file TransmitterComponent.cpp.

◆ getCWSweepStepRes()

double getCWSweepStepRes ( ) const

virtual

Gets the CW frequency step resolution.

Returns: The resolution.

Definition at line 387 of file TransmitterComponent.cpp.

◆ getCWSweepStopFrequency()

double getCWSweepStopFrequency ( int index ) const

virtual

Gets the stop frequency for a signal sweep for a given CW tone generator.

Parameters

index CW tone generator index.

Returns: The stop frequency, in Hz.

Definition at line 518 of file TransmitterComponent.cpp.

◆ getCWSweepStopRange()

BasicDoubleList getCWSweepStopRange ( ) const

virtual

Gets the CW stop frequency range.

Returns: A list containing the minimum and maximum frequency values.

Definition at line 360 of file TransmitterComponent.cpp.

◆ getCWSweepStopRes()

double getCWSweepStopRes ( ) const

virtual

Gets the CW stop frequency resolution.

Returns: The resolution.

Definition at line 369 of file TransmitterComponent.cpp.

◆ getDebugName()

std::string getDebugName ( ) const

virtualinherited

Gets the debug name for this object.

Returns: The debug name, as a string.

Definition at line 138 of file Debuggable.cpp.

◆ getFrequency()

double getFrequency ( ) const

virtual

Gets the transmitter center frequency.

Returns: The transmitter center frequency, in Hz.

Definition at line 187 of file TransmitterComponent.cpp.

◆ getFrequencyRange()

BasicDoubleList getFrequencyRange ( ) const

virtual

Gets the transmitter center frequency range.

Returns: A list containing the minimum and maximum frequencies.

Definition at line 229 of file TransmitterComponent.cpp.

◆ getFrequencyRes()

double getFrequencyRes ( ) const

virtual

Gets the transmitter center frequency resolution.

Returns: The frequency resolution, in Hz.

Definition at line 237 of file TransmitterComponent.cpp.

◆ getFrequencyUnit()

double getFrequencyUnit ( ) const

virtual

Gets the transmitter center frequency units.

Returns: The frequency units, in Hz.

Definition at line 242 of file TransmitterComponent.cpp.

◆ getIndex()

int getIndex ( ) const

virtualinherited

Gets the index number of the component.

Returns: The index number, as an integer.

Definition at line 56 of file RadioComponent.cpp.

◆ getName()

std::string getName ( ) const

virtualinherited

Gets the name of the configurable object.

Returns: The name, as a string.

Definition at line 83 of file Configurable.cpp.

◆ getParent()

RadioHandler * getParent ( ) const

virtualinherited

Gets the "parent" radio handler for this component.

Returns: A pointer to the RadioHandler object.

Definition at line 66 of file RadioComponent.cpp.

◆ isDebug()

bool isDebug ( ) const

virtualinherited

Gets whether this object produces debug output.

Returns: True if producing debug, false otherwise.

Definition at line 133 of file Debuggable.cpp.

◆ isEnabled()

bool isEnabled ( ) const

virtualinherited

Gets whether or not the component is enabled.

Returns: True if enabled, false otherwise.

Definition at line 88 of file RadioComponent.cpp.

◆ normalizedBool()

std::string normalizedBool ( const std::string & val )

protectedvirtualinherited

Normalizes a Boolean string value.

Returns: The "normalized" string value.

Definition at line 241 of file Configurable.cpp.

◆ normalizedConfigurationDict()

ConfigurationDict normalizedConfigurationDict ( const ConfigurationDict & cfg )

protectedvirtualinherited

Normalizes an incoming configuration dictionary.

"Normalizing" a configuration dictionary replaces certain strings representing Boolean values ("yes", "on", "true", "no", "off", and "false", case is irrelevant) with standard values ("0" and "1").

Note: The default behavior of this method normalizes every string in the configuration dictionary. Override this method if certain configuration items need to be protected from normalization.

Returns: The new configuration dictionary.

Definition at line 232 of file Configurable.cpp.

◆ operator=()

TransmitterComponent & operator= ( const TransmitterComponent & other )

virtual

Assignment operator for TransmitterComponent objects.

Parameters

other The TransmitterComponent object to copy.

Returns: A reference to the assigned object.

Definition at line 82 of file TransmitterComponent.cpp.

◆ rawString()

std::string rawString ( const std::string & data )

virtualinherited

Gets a "raw" string representation of a given data string.

"Raw" string representations mimic Python string representations. Whitespace characters are denoted by backslash representations ("\\r", "\\n", "\\t", "\\v", "\\f"), while other non-printable characters are represented with hex representation ("\\x00", etc.)

Parameters

data	Data string

Returns: The data's "raw" representation.

Definition at line 143 of file Debuggable.cpp.

◆ setAttenuation()

bool setAttenuation ( double atten )

virtual

Sets the attenuation.

Parameters

atten The new attenuation (dB).

Returns: True if successful, false otherwise.

Definition at line 213 of file TransmitterComponent.cpp.

◆ setConfiguration()

bool setConfiguration ( ConfigurationDict & cfg )

virtual

Sets the configuration dictionary for this component.

Parameters

cfg	The component configuration dictionary.

Returns: True if successful, false otherwise.

Reimplemented from RadioComponent.

Definition at line 118 of file TransmitterComponent.cpp.

◆ setConfigurationValue()

bool setConfigurationValue	(	const std::string &	key,
		const std::string &	value
	)

virtualinherited

Sets a named configuration value to a string.

Note: The default behavior of this method is to normalize the incoming value.

Parameters

key	The key string in the configuration dictionary.
value	The new value.

Returns: True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 177 of file Configurable.cpp.

◆ setConfigurationValueToBool()

bool setConfigurationValueToBool	(	const std::string &	key,
		const bool	value
	)

virtualinherited

Sets a named configuration value to a Boolean.

Parameters

key	The key string in the configuration dictionary.
value	The new value.

Returns: True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 193 of file Configurable.cpp.

◆ setConfigurationValueToDbl()

bool setConfigurationValueToDbl	(	const std::string &	key,
		const double	value
	)

virtualinherited

Sets a named configuration value to a double value.

Parameters

key	The key string in the configuration dictionary.
value	The new value.

Returns: True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 211 of file Configurable.cpp.

◆ setConfigurationValueToInt()

bool setConfigurationValueToInt	(	const std::string &	key,
		const int	value
	)

virtualinherited

Sets a named configuration value to an integer value.

Parameters

key	The key string in the configuration dictionary.
value	The new value.

Returns: True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 199 of file Configurable.cpp.

◆ setConfigurationValueToUInt()

bool setConfigurationValueToUInt	(	const std::string &	key,
		const unsigned int	value
	)

virtualinherited

Sets a named configuration value to an unsigned integer value.

Parameters

key	The key string in the configuration dictionary.
value	The new value.

Returns: True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 205 of file Configurable.cpp.

◆ setCWAmplitude()

bool setCWAmplitude	(	int	index,
		double	amp
	)

virtual

Sets the signal amplitude for a given CW tone generator.

Parameters

index	CW tone generator index.
amp	The new signal amplitude (scale units).

Returns: True if successful, false otherwise.

Definition at line 473 of file TransmitterComponent.cpp.

◆ setCWConfiguration()

bool setCWConfiguration	(	int	index,
		ConfigurationDict &	cfg
	)

virtual

Sets the configuration dictionary for a given CW tone generator.

Parameters

index	CW tone generator index.
cfg	The component configuration dictionary.

Returns: True if successful, false otherwise.

Definition at line 437 of file TransmitterComponent.cpp.

◆ setCWFrequency()

bool setCWFrequency	(	int	index,
		double	freq
	)

virtual

Sets the constant frequency for a given CW tone generator.

Parameters

index	CW tone generator index.
freq	The new constant frequency (Hz).

Returns: True if successful, false otherwise.

Definition at line 455 of file TransmitterComponent.cpp.

◆ setCWFrequencySweep()

bool setCWFrequencySweep	(	int	index,
		double	start,
		double	stop,
		double	step,
		double	dwell
	)

virtual

Sets the parameters for a frequency sweep for a given CW tone generator.

Parameters

index	CW tone generator index.
start	The new start frequency (Hz).
stop	The new stop frequency (Hz).
step	The new frequency step (Hz).
dwell	The new dwell time (sample clocks).

Returns: True if successful, false otherwise.

Definition at line 545 of file TransmitterComponent.cpp.

◆ setCWPhase()

bool setCWPhase	(	int	index,
		double	phase
	)

virtual

Sets the signal phase for a given CW tone generator.

Parameters

index	CW tone generator index.
phase	The new signal phase (degrees).

Returns: True if successful, false otherwise.

Definition at line 491 of file TransmitterComponent.cpp.

◆ setDebugFile()

void setDebugFile ( FILE * debug_fp )

virtualinherited

Sets the debug file pointer for this object.

Parameters

debug_fp File to send debug output to.

Definition at line 81 of file Debuggable.cpp.

◆ setDebugName()

void setDebugName ( const std::string & debug_name )

virtualinherited

Sets the debug name for this object.

Use this method to set unique debug names for objects of the same class for easy differentiation.

Parameters

debug_name Name for identifying this object in debug output.

Definition at line 74 of file Debuggable.cpp.

◆ setDebugTimeFormat()

void setDebugTimeFormat ( const std::string & debug_timefmt )

virtualinherited

Sets the debug time format for this object.

Parameters

debug_timefmt Format string for displaying timestamp, as compatible with strftime(). If this is an empty string, don't display a timestamp.

Definition at line 88 of file Debuggable.cpp.

◆ setFrequency()

bool setFrequency ( double freq )

virtual

Sets the transmitter center frequency.

Parameters

freq	The new transmitter center frequency (Hz).

Returns: True if successful, false otherwise.

Definition at line 192 of file TransmitterComponent.cpp.

◆ setIndex()

void setIndex ( int index )

virtualinherited

Sets the index number of the component.

Parameters

index The index number.

Definition at line 61 of file RadioComponent.cpp.

◆ setName()

void setName ( const std::string & name )

virtualinherited

Sets the name of the configurable object.

Parameters

name	The new name.

Definition at line 88 of file Configurable.cpp.

◆ setParent()

void setParent ( RadioHandler * parent )

virtualinherited

Sets the "parent" radio handler for this component.

Parameters

parent A pointer to the RadioHandler object.

Definition at line 71 of file RadioComponent.cpp.

◆ supportsCW()

bool supportsCW ( ) const

virtual

Gets whether the transmitter supports CW tone generation.

Returns: True if supported, false otherwise.

Definition at line 260 of file TransmitterComponent.cpp.

◆ supportsCWSweep() [1/2]

bool supportsCWSweep ( ) const

virtual

Gets whether the transmitter supports CW tone sweeping.

Returns: True if supported, false otherwise.

Definition at line 333 of file TransmitterComponent.cpp.

◆ supportsCWSweep() [2/2]

bool supportsCWSweep ( int index ) const

virtual

Gets whether or not a given CW tone generator supports signal sweeps.

Parameters

index CW tone generator index.

Returns: True if supported, false otherwise.

Definition at line 500 of file TransmitterComponent.cpp.

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

/home/abuild/rpmbuild/BUILD/libcyberradio-24.10.14/libcyberradio/include/LibCyberRadio/Driver/TransmitterComponent.h
/home/abuild/rpmbuild/BUILD/libcyberradio-24.10.14/libcyberradio/libcyberradio/Driver/TransmitterComponent.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TransmitterComponent() [1/2]

◆ TransmitterComponent() [2/2]

Member Function Documentation

◆ debug()

◆ debugBool()

◆ disable()

◆ disableCW()

◆ enable()

◆ enableCW()

◆ executeAttenCommand()

◆ executeAttenQuery()

◆ executeEnableCommand()

◆ executeEnableQuery()

◆ executeFreqCommand()

◆ executeFreqQuery()

◆ getAttenuation()

◆ getAttenuationRange()

◆ getAttenuationRes()

◆ getConfiguration()

◆ getConfigurationValue()

◆ getConfigurationValueAsBool()

◆ getConfigurationValueAsDbl()

◆ getConfigurationValueAsInt()

◆ getConfigurationValueAsUInt()

◆ getCWAmplitude()

◆ getCWAmplitudeRange()

◆ getCWAmplitudeRes()

◆ getCWConfiguration()

◆ getCWFrequency()

◆ getCWFrequencyRange()

◆ getCWFrequencyRes()

◆ getCWIndexRange()

◆ getCWNum()

◆ getCWPhase()

◆ getCWPhaseRange()

◆ getCWPhaseRes()

◆ getCWSweepDwellRange()

◆ getCWSweepDwellRes()

◆ getCWSweepDwellTime()

◆ getCWSweepFrequencyStep()

◆ getCWSweepStartFrequency()

◆ getCWSweepStartRange()

◆ getCWSweepStartRes()

◆ getCWSweepStepRange()

◆ getCWSweepStepRes()

◆ getCWSweepStopFrequency()

◆ getCWSweepStopRange()

◆ getCWSweepStopRes()

◆ getDebugName()

◆ getFrequency()

◆ getFrequencyRange()

◆ getFrequencyRes()

◆ getFrequencyUnit()

◆ getIndex()

◆ getName()

◆ getParent()

◆ isDebug()

◆ isEnabled()

◆ normalizedBool()

◆ normalizedConfigurationDict()

◆ operator=()

◆ rawString()

◆ setAttenuation()

◆ setConfiguration()

◆ setConfigurationValue()

◆ setConfigurationValueToBool()

◆ setConfigurationValueToDbl()

◆ setConfigurationValueToInt()

◆ setConfigurationValueToUInt()

◆ setCWAmplitude()

◆ setCWConfiguration()

◆ setCWFrequency()

◆ setCWFrequencySweep()

◆ setCWPhase()

◆ setDebugFile()

◆ setDebugName()