libcyberradio  22.01.24
CWToneGenComponent Class Reference

Continuous-wave (CW) tone generator component class for the NDR651. More...

#include <CWToneGenComponent.h>

Inheritance diagram for CWToneGenComponent:
CWToneGenComponent RadioComponent Configurable Debuggable

Public Member Functions

 CWToneGenComponent (int index=0, RadioHandler *parent=NULL, bool debug=false, int txIndex=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 CWToneGenComponentoperator= (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 RadioHandlergetParent () 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

Continuous-wave (CW) tone generator component class for the NDR651.

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 47 of file CWToneGenComponent.h.

Constructor & Destructor Documentation

◆ CWToneGenComponent() [1/2]

CWToneGenComponent ( int  index = 0,
RadioHandler parent = NULL,
bool  debug = false,
int  txIndex = 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.

Parameters
indexThe index number of this component.
parentA pointer to the RadioHandler object that "owns" this component.
debugWhether the component supports debug output.
txIndexTransmitter index associated with this component.
frequencyConstant frequency (Hz).
amplitudeSignal amplitude (scale units).
phaseSignal phase (degrees).
sweepStartFrequency sweep start (Hz).
sweepStopFrequency sweep stop (Hz).
sweepStepFrequency sweep step (Hz).
dwellTimeDwell time (ADC samples).

◆ CWToneGenComponent() [2/2]

Copies a CWToneGenComponent object.

Parameters
otherThe CWToneGenComponent object to copy.

Definition at line 79 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
formatThe 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
xBoolean 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)
virtualinherited

Enables this component.

Parameters
enabledWhether 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 
)
protectedvirtualinherited

Executes the CW sweep set command.

Parameters
indexCW tone generator index.
txIndexTransmitter index associated with this component.
sweepStartStart frequency (Hz).
sweepStopStop frequency (Hz).
sweepStepFrequency step (Hz).
dwellTimeDwell 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 
)
protectedvirtualinherited

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
indexCW tone generator index.
txIndexTransmitter index associated with this component.
sweepStartStart frequency (Hz) (return).
sweepStopStop frequency (Hz) (return).
sweepStepFrequency step (Hz) (return).
dwellTimeDwell 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 
)
protectedvirtualinherited

Executes the CW tone set command.

Parameters
indexCW tone generator index.
txIndexTransmitter index associated with this component.
freqFrequency (Hz).
ampAmplitude (scale units).
phasePhase (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 
)
protectedvirtualinherited

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
indexCW tone generator index.
txIndexTransmitter index associated with this component.
freqFrequency (Hz) (return).
ampAmplitude (scale units) (return).
phasePhase (degrees) (return).
Returns
True if the command succeeded, false otherwise.

Definition at line 544 of file CWToneGenComponent.cpp.

◆ getAmplitude()

double getAmplitude ( ) const
virtualinherited

Gets the signal amplitude.

Returns
The signal amplitude, in scale units.

Definition at line 405 of file CWToneGenComponent.cpp.

◆ getAmplitudeRange()

BasicDoubleList getAmplitudeRange ( ) const
virtualinherited

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
virtualinherited

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
keyThe 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
keyThe 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
keyThe 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
keyThe 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
keyThe 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
virtualinherited

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
virtualinherited

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
virtualinherited

Gets the constant frequency.

Returns
The constant frequency, in Hz.

Definition at line 382 of file CWToneGenComponent.cpp.

◆ getFrequencyRange()

BasicDoubleList getFrequencyRange ( ) const
virtualinherited

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
virtualinherited

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
virtualinherited

Gets the signal phase.

Returns
The signal phase, in degrees.

Definition at line 429 of file CWToneGenComponent.cpp.

◆ getPhaseRange()

BasicDoubleList getPhaseRange ( ) const
virtualinherited

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
virtualinherited

Gets the phase resolution.

Returns
The phase resolution, in degrees.

Definition at line 325 of file CWToneGenComponent.cpp.

◆ getSweepDwellTime()

double getSweepDwellTime ( ) const
virtualinherited

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
virtualinherited

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
virtualinherited

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
virtualinherited

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
virtualinherited

Gets the sweep start resolution.

Returns
The frequency resolution, in Hz.

Definition at line 338 of file CWToneGenComponent.cpp.

◆ getSweepStepRange()

BasicDoubleList getSweepStepRange ( ) const
virtualinherited

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
virtualinherited

Gets the sweep step resolution.

Returns
The frequency resolution, in Hz.

Definition at line 364 of file CWToneGenComponent.cpp.

◆ getSweepStopFrequency()

double getSweepStopFrequency ( ) const
virtualinherited

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
virtualinherited

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
virtualinherited

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
otherThe CWToneGenComponent object to copy.
Returns
A reference to the assigned object.

Definition at line 84 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
dataData string
Returns
The data's "raw" representation.

Definition at line 143 of file Debuggable.cpp.

◆ setAmplitude()

bool setAmplitude ( double  amp)
virtualinherited

Sets the signal amplitude.

Parameters
ampThe new signal amplitude (scale units).
Returns
True if successful, false otherwise.

Definition at line 410 of file CWToneGenComponent.cpp.

◆ setConfiguration()

bool setConfiguration ( ConfigurationDict cfg)
virtualinherited

Sets the configuration dictionary for this component.

Parameters
cfgThe 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
keyThe key string in the configuration dictionary.
valueThe 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
keyThe key string in the configuration dictionary.
valueThe 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
keyThe key string in the configuration dictionary.
valueThe 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
keyThe key string in the configuration dictionary.
valueThe 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
keyThe key string in the configuration dictionary.
valueThe 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_fpFile 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_nameName 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_timefmtFormat 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)
virtualinherited

Sets the constant frequency.

Parameters
freqThe 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 
)
virtualinherited

Sets the parameters for a frequency sweep.

Parameters
startThe new start frequency (Hz).
stopThe new stop frequency (Hz).
stepThe new frequency step (Hz).
dwellThe 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
indexThe 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
nameThe 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
parentA pointer to the RadioHandler object.

Definition at line 71 of file RadioComponent.cpp.

◆ setPhase()

bool setPhase ( double  phase)
virtualinherited

Sets the signal phase.

Parameters
phaseThe new signal phase (degrees).
Returns
True if successful, false otherwise.

Definition at line 434 of file CWToneGenComponent.cpp.

◆ supportsSweep()

bool supportsSweep ( ) const
virtualinherited

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: