Base continuous-wave (CW) tone generator component class. More...

#include <CWToneGenComponent.h>

Inheritance diagram for CWToneGenComponent:

Public Member Functions
	CWToneGenComponent (const std::string &name="CWTONE", int index=0, RadioHandler *parent=NULL, bool debug=false, int txIndex=0, double freqRangeMin=0.0, double freqRangeMax=0.0, double freqRes=0.0, double freqUnits=0.0, double ampRangeMin=0.0, double ampRangeMax=0.0, double ampRes=0.0, double phaseRangeMin=0.0, double phaseRangeMax=0.0, double phaseRes=0.0, double sweepStartRangeMin=0.0, double sweepStartRangeMax=0.0, double sweepStartRes=0.0, double sweepStopRangeMin=0.0, double sweepStopRangeMax=0.0, double sweepStopRes=0.0, double sweepStepRangeMin=0.0, double sweepStepRangeMax=0.0, double sweepStepRes=0.0, double dwellTimeRangeMin=0.0, double dwellTimeRangeMax=0.0, double dwellTimeRes=0.0, double frequency=0.0, double amplitude=0.0, double phase=0.0, double sweepStart=0.0, double sweepStop=0.0, double sweepStep=0.0, double dwellTime=0.0)
	Constructs a CWToneGenComponent object. More...

virtual	~CWToneGenComponent ()
	Destroys a CWToneGenComponent object.

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

virtual CWToneGenComponent &	operator= (const CWToneGenComponent &other)
	Assignment operator for CWToneGenComponent 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 BasicDoubleList	getFrequencyRange () const
	Gets the frequency range. More...

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

virtual BasicDoubleList	getAmplitudeRange () const
	Gets the amplitude range. More...

virtual double	getAmplitudeRes () const
	Gets the amplitude resolution. More...

virtual BasicDoubleList	getPhaseRange () const
	Gets the phase range. More...

virtual double	getPhaseRes () const
	Gets the phase resolution. More...

virtual BasicDoubleList	getSweepStartRange () const
	Gets the sweep start range. More...

virtual double	getSweepStartRes () const
	Gets the sweep start resolution. More...

virtual BasicDoubleList	getSweepStopRange () const
	Gets the sweep stop range. More...

virtual double	getSweepStopRes () const
	Gets the sweep stop resolution. More...

virtual BasicDoubleList	getSweepStepRange () const
	Gets the sweep step range. More...

virtual double	getSweepStepRes () const
	Gets the sweep step resolution. More...

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

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

virtual double	getFrequency () const
	Gets the constant frequency. More...

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

virtual double	getAmplitude () const
	Gets the signal amplitude. More...

virtual bool	setAmplitude (double amp)
	Sets the signal amplitude. More...

virtual double	getPhase () const
	Gets the signal phase. More...

virtual bool	setPhase (double phase)
	Sets the signal phase. More...

virtual bool	supportsSweep () const
	Gets whether or not the generator supports signal sweeps. More...

virtual double	getSweepStartFrequency () const
	Gets the start frequency for a signal sweep. More...

virtual double	getSweepStopFrequency () const
	Gets the stop frequency for a signal sweep. More...

virtual double	getSweepFrequencyStep () const
	Gets the frequency step for a signal sweep. More...

virtual double	getSweepDwellTime () const
	Gets the dwell time for a signal sweep. More...

virtual bool	setFrequencySweep (double start, double stop, double step, double dwell)
	Sets the parameters for a frequency sweep. 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	executeToneQuery (int index, int txIndex, double &freq, double &amp, double &phase)
	Executes the CW tone query command. More...

virtual bool	executeToneCommand (int index, int txIndex, double &freq, double &amp, double &phase)
	Executes the CW tone set command. More...

virtual bool	executeSweepQuery (int index, int txIndex, double &sweepStart, double &sweepStop, double &sweepStep, double &dwellTime)
	Executes the CW sweep query command. More...

virtual bool	executeSweepCommand (int index, int txIndex, double &sweepStart, double &sweepStop, double &sweepStep, double &dwellTime)
	Executes the CW sweep 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 continuous-wave (CW) tone generator component class.

A radio handler object maintains one CW tone generator component object per tone generator on the radio.

Configuration dictionary elements:

"enable": Whether or not this component is enabled [Boolean]

Definition at line 43 of file CWToneGenComponent.h.

Constructor & Destructor Documentation

◆ CWToneGenComponent() [1/2]

CWToneGenComponent	(	const std::string &	name = `"CWTONE"`,
		int	index = `0`,
		RadioHandler *	parent = `NULL`,
		bool	debug = `false`,
		int	txIndex = `0`,
		double	freqRangeMin = `0.0`,
		double	freqRangeMax = `0.0`,
		double	freqRes = `0.0`,
		double	freqUnits = `0.0`,
		double	ampRangeMin = `0.0`,
		double	ampRangeMax = `0.0`,
		double	ampRes = `0.0`,
		double	phaseRangeMin = `0.0`,
		double	phaseRangeMax = `0.0`,
		double	phaseRes = `0.0`,
		double	sweepStartRangeMin = `0.0`,
		double	sweepStartRangeMax = `0.0`,
		double	sweepStartRes = `0.0`,
		double	sweepStopRangeMin = `0.0`,
		double	sweepStopRangeMax = `0.0`,
		double	sweepStopRes = `0.0`,
		double	sweepStepRangeMin = `0.0`,
		double	sweepStepRangeMax = `0.0`,
		double	sweepStepRes = `0.0`,
		double	dwellTimeRangeMin = `0.0`,
		double	dwellTimeRangeMax = `0.0`,
		double	dwellTimeRes = `0.0`,
		double	frequency = `0.0`,
		double	amplitude = `0.0`,
		double	phase = `0.0`,
		double	sweepStart = `0.0`,
		double	sweepStop = `0.0`,
		double	sweepStep = `0.0`,
		double	dwellTime = `0.0`
	)

Constructs a CWToneGenComponent object.

Note: If the CW tone generator does NOT support frequency sweeping, set sweepStartRangeMin and sweepStartRangeMax to the same value.

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.
txIndex	Transmitter index associated with this component.
freqRangeMin	Minimum tunable frequency (Hz).
freqRangeMax	Maximum tunable frequency (Hz).
freqRes	Tunable frequency resolution (Hz).
freqUnits	Tunable frequency units (Hz).
ampRangeMin	Minimum amplitude (scale units).
ampRangeMax	Maximum amplitude (scale units).
ampRes	Amplitude resolution (scale units).
phaseRangeMin	Minimum phase (degrees).
phaseRangeMax	Maximum phase (degrees).
phaseRes	Phase resolution (degrees).
sweepStartRangeMin	Minimum sweep start frequency (Hz).
sweepStartRangeMax	Maximum sweep start frequency (Hz).
sweepStartRes	Sweep start frequency resolution (Hz).
sweepStopRangeMin	Minimum sweep stop frequency (Hz).
sweepStopRangeMax	Maximum sweep stop frequency (Hz).
sweepStopRes	Sweep stop frequency resolution (Hz).
sweepStepRangeMin	Minimum sweep step frequency (Hz).
sweepStepRangeMax	Maximum sweep step frequency (Hz).
sweepStepRes	Sweep step frequency resolution (Hz).
dwellTimeRangeMin	Minimum dwell time (ADC samples).
dwellTimeRangeMax	Maximum dwell time (ADC samples).
dwellTimeRes	Dwell time resolution (ADC samples).
frequency	Constant frequency (Hz).
amplitude	Signal amplitude (scale units).
phase	Signal phase (degrees).
sweepStart	Frequency sweep start (Hz).
sweepStop	Frequency sweep stop (Hz).
sweepStep	Frequency sweep step (Hz).
dwellTime	Dwell time (ADC samples).

Definition at line 27 of file CWToneGenComponent.cpp.

◆ CWToneGenComponent() [2/2]

CWToneGenComponent ( const CWToneGenComponent & other )

Copies a CWToneGenComponent object.

Parameters

other The CWToneGenComponent object to copy.

Definition at line 104 of file CWToneGenComponent.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.

◆ 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 179 of file CWToneGenComponent.cpp.

◆ executeSweepCommand()

bool executeSweepCommand	(	int	index,
		int	txIndex,
		double &	sweepStart,
		double &	sweepStop,
		double &	sweepStep,
		double &	dwellTime
	)

protectedvirtual

Executes the CW sweep set command.

Parameters

index	CW tone generator index.
txIndex	Transmitter index associated with this component.
sweepStart	Start frequency (Hz).
sweepStop	Stop frequency (Hz).
sweepStep	Frequency step (Hz).
dwellTime	Dwell time (ADC samples).

Returns: True if the command succeeded, false otherwise.

Definition at line 637 of file CWToneGenComponent.cpp.

◆ executeSweepQuery()

bool executeSweepQuery	(	int	index,
		int	txIndex,
		double &	sweepStart,
		double &	sweepStop,
		double &	sweepStep,
		double &	dwellTime
	)

protectedvirtual

Executes the CW sweep 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	CW tone generator index.
txIndex	Transmitter index associated with this component.
sweepStart	Start frequency (Hz) (return).
sweepStop	Stop frequency (Hz) (return).
sweepStep	Frequency step (Hz) (return).
dwellTime	Dwell time (ADC samples) (return).

Returns: True if the command succeeded, false otherwise.

Definition at line 602 of file CWToneGenComponent.cpp.

◆ executeToneCommand()

bool executeToneCommand	(	int	index,
		int	txIndex,
		double &	freq,
		double &	amp,
		double &	phase
	)

protectedvirtual

Executes the CW tone set command.

Parameters

index	CW tone generator index.
txIndex	Transmitter index associated with this component.
freq	Frequency (Hz).
amp	Amplitude (scale units).
phase	Phase (degrees).

Returns: True if the command succeeded, false otherwise.

Definition at line 576 of file CWToneGenComponent.cpp.

◆ executeToneQuery()

bool executeToneQuery	(	int	index,
		int	txIndex,
		double &	freq,
		double &	amp,
		double &	phase
	)

protectedvirtual

Executes the CW tone 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	CW tone generator index.
txIndex	Transmitter index associated with this component.
freq	Frequency (Hz) (return).
amp	Amplitude (scale units) (return).
phase	Phase (degrees) (return).

Returns: True if the command succeeded, false otherwise.

Definition at line 544 of file CWToneGenComponent.cpp.

◆ getAmplitude()

double getAmplitude ( ) const

virtual

Gets the signal amplitude.

Returns: The signal amplitude, in scale units.

Definition at line 405 of file CWToneGenComponent.cpp.

◆ getAmplitudeRange()

BasicDoubleList getAmplitudeRange ( ) const

virtual

Gets the amplitude range.

Returns: A list containing the minimum and maximum amplitudes.

Definition at line 304 of file CWToneGenComponent.cpp.

◆ getAmplitudeRes()

double getAmplitudeRes ( ) const

virtual

Gets the amplitude resolution.

Returns: The amplitude resolution, in scale units.

Definition at line 312 of file CWToneGenComponent.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.

◆ 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.

◆ getDwellTimeRange()

BasicDoubleList getDwellTimeRange ( ) const

virtual

Gets the dwell time range.

Returns: A list containing the minimum and maximum dwell times.

Definition at line 369 of file CWToneGenComponent.cpp.

◆ getDwellTimeRes()

double getDwellTimeRes ( ) const

virtual

Gets the dwell time resolution.

Returns: The dwell time resolution, in ADC samples.

Definition at line 377 of file CWToneGenComponent.cpp.

◆ getFrequency()

double getFrequency ( ) const

virtual

Gets the constant frequency.

Returns: The constant frequency, in Hz.

Definition at line 382 of file CWToneGenComponent.cpp.

◆ getFrequencyRange()

BasicDoubleList getFrequencyRange ( ) const

virtual

Gets the frequency range.

Returns: A list containing the minimum and maximum frequencies.

Definition at line 291 of file CWToneGenComponent.cpp.

◆ getFrequencyRes()

double getFrequencyRes ( ) const

virtual

Gets the frequency resolution.

Returns: The frequency resolution, in Hz.

Definition at line 299 of file CWToneGenComponent.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.

◆ getPhase()

double getPhase ( ) const

virtual

Gets the signal phase.

Returns: The signal phase, in degrees.

Definition at line 429 of file CWToneGenComponent.cpp.

◆ getPhaseRange()

BasicDoubleList getPhaseRange ( ) const

virtual

Gets the phase range.

Returns: A list containing the minimum and maximum phases.

Definition at line 317 of file CWToneGenComponent.cpp.

◆ getPhaseRes()

double getPhaseRes ( ) const

virtual

Gets the phase resolution.

Returns: The phase resolution, in degrees.

Definition at line 325 of file CWToneGenComponent.cpp.

◆ getSweepDwellTime()

double getSweepDwellTime ( ) const

virtual

Gets the dwell time for a signal sweep.

Returns: The dwell time, in ADC samples.

Definition at line 473 of file CWToneGenComponent.cpp.

◆ getSweepFrequencyStep()

double getSweepFrequencyStep ( ) const

virtual

Gets the frequency step for a signal sweep.

Returns: The frequency step, in Hz.

Definition at line 468 of file CWToneGenComponent.cpp.

◆ getSweepStartFrequency()

double getSweepStartFrequency ( ) const

virtual

Gets the start frequency for a signal sweep.

Returns: The start frequency, in Hz.

Definition at line 458 of file CWToneGenComponent.cpp.

◆ getSweepStartRange()

BasicDoubleList getSweepStartRange ( ) const

virtual

Gets the sweep start range.

Returns: A list containing the minimum and maximum frequencies.

Definition at line 330 of file CWToneGenComponent.cpp.

◆ getSweepStartRes()

double getSweepStartRes ( ) const

virtual

Gets the sweep start resolution.

Returns: The frequency resolution, in Hz.

Definition at line 338 of file CWToneGenComponent.cpp.

◆ getSweepStepRange()

BasicDoubleList getSweepStepRange ( ) const

virtual

Gets the sweep step range.

Returns: A list containing the minimum and maximum frequencies.

Definition at line 356 of file CWToneGenComponent.cpp.

◆ getSweepStepRes()

double getSweepStepRes ( ) const

virtual

Gets the sweep step resolution.

Returns: The frequency resolution, in Hz.

Definition at line 364 of file CWToneGenComponent.cpp.

◆ getSweepStopFrequency()

double getSweepStopFrequency ( ) const

virtual

Gets the stop frequency for a signal sweep.

Returns: The stop frequency, in Hz.

Definition at line 463 of file CWToneGenComponent.cpp.

◆ getSweepStopRange()

BasicDoubleList getSweepStopRange ( ) const

virtual

Gets the sweep stop range.

Returns: A list containing the minimum and maximum frequencies.

Definition at line 343 of file CWToneGenComponent.cpp.

◆ getSweepStopRes()

double getSweepStopRes ( ) const

virtual

Gets the sweep stop resolution.

Returns: The frequency resolution, in Hz.

Definition at line 351 of file CWToneGenComponent.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=()

CWToneGenComponent & operator= ( const CWToneGenComponent & other )

virtual

Assignment operator for CWToneGenComponent objects.

Parameters

other The CWToneGenComponent object to copy.

Returns: A reference to the assigned object.

Definition at line 140 of file CWToneGenComponent.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.

◆ setAmplitude()

bool setAmplitude ( double amp )

virtual

Sets the signal amplitude.

Parameters

amp	The new signal amplitude (scale units).

Returns: True if successful, false otherwise.

Definition at line 410 of file CWToneGenComponent.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 184 of file CWToneGenComponent.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.

◆ 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 constant frequency.

Parameters

freq	The new constant frequency (Hz).

Returns: True if successful, false otherwise.

Definition at line 387 of file CWToneGenComponent.cpp.

◆ setFrequencySweep()

bool setFrequencySweep	(	double	start,
		double	stop,
		double	step,
		double	dwell
	)

virtual

Sets the parameters for a frequency sweep.

Parameters

start	The new start frequency (Hz).
stop	The new stop frequency (Hz).
step	The new frequency step (Hz).
dwell	The new dwell time (ADC samples).

Returns: True if successful, false otherwise.

Definition at line 478 of file CWToneGenComponent.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.

◆ setPhase()

bool setPhase ( double phase )

virtual

Sets the signal phase.

Parameters

phase The new signal phase (degrees).

Returns: True if successful, false otherwise.

Definition at line 434 of file CWToneGenComponent.cpp.

◆ supportsSweep()

bool supportsSweep ( ) const

virtual

Gets whether or not the generator supports signal sweeps.

Returns: True if supported, false otherwise.

Definition at line 452 of file CWToneGenComponent.cpp.

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CWToneGenComponent() [1/2]

◆ CWToneGenComponent() [2/2]

Member Function Documentation

◆ debug()

◆ debugBool()

◆ disable()

◆ enable()

◆ executeSweepCommand()

◆ executeSweepQuery()

◆ executeToneCommand()

◆ executeToneQuery()

◆ getAmplitude()

◆ getAmplitudeRange()

◆ getAmplitudeRes()

◆ getConfiguration()

◆ getConfigurationValue()

◆ getConfigurationValueAsBool()

◆ getConfigurationValueAsDbl()

◆ getConfigurationValueAsInt()

◆ getConfigurationValueAsUInt()

◆ getDebugName()

◆ getDwellTimeRange()

◆ getDwellTimeRes()

◆ getFrequency()

◆ getFrequencyRange()

◆ getFrequencyRes()

◆ getIndex()

◆ getName()

◆ getParent()

◆ getPhase()

◆ getPhaseRange()

◆ getPhaseRes()

◆ getSweepDwellTime()

◆ getSweepFrequencyStep()

◆ getSweepStartFrequency()

◆ getSweepStartRange()

◆ getSweepStartRes()

◆ getSweepStepRange()

◆ getSweepStepRes()

◆ getSweepStopFrequency()

◆ getSweepStopRange()

◆ getSweepStopRes()

◆ isDebug()

◆ isEnabled()

◆ normalizedBool()

◆ normalizedConfigurationDict()

◆ operator=()

◆ rawString()

◆ setAmplitude()

◆ setConfiguration()

◆ setConfigurationValue()

◆ setConfigurationValueToBool()

◆ setConfigurationValueToDbl()

◆ setConfigurationValueToInt()

◆ setConfigurationValueToUInt()

◆ setDebugFile()

◆ setDebugName()

◆ setDebugTimeFormat()

◆ setFrequency()

◆ setFrequencySweep()

◆ setIndex()

◆ setName()

◆ setParent()

◆ setPhase()

◆ supportsSweep()