![]() |
libcyberradio
22.01.24
|
Tuner component class for the NDR651. More...
#include <TunerComponent.h>
Public Member Functions | |
| TunerComponent (int index=1, ::LibCyberRadio::Driver::RadioHandler *parent=NULL, bool debug=false, double frequency=800e6, double attenuation=0.0, int filter=0) | |
| Constructs a TunerComponent object. More... | |
| virtual | ~TunerComponent () |
| Destroys a TunerComponent object. | |
| TunerComponent (const TunerComponent &other) | |
| Copies a TunerComponent object. More... | |
| virtual TunerComponent & | operator= (const TunerComponent &other) |
| Assignment operator for TunerComponent 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 tuned frequency. More... | |
| virtual bool | setFrequency (double freq) |
| Sets the tuned frequency. More... | |
| virtual double | getAttenuation () const |
| Gets the attenuation. More... | |
| virtual bool | setAttenuation (double atten) |
| Sets the attenuation. More... | |
| virtual int | getFilter () const |
| Gets the filter setting. More... | |
| virtual bool | setFilter (int filter) |
| Sets the filter setting. More... | |
| virtual int | getTimingAdjustment () const |
| Gets the timing adjustment setting. More... | |
| virtual bool | setTimingAdjustment (int timingAdj) |
| Sets the timing adjustment setting. More... | |
| virtual BasicDoubleList | getFrequencyRange () const |
| Gets the tunable frequency range. More... | |
| virtual double | getFrequencyRes () const |
| Gets the tuned frequency resolution. More... | |
| virtual double | getFrequencyUnit () const |
| Gets the tuned frequency units. More... | |
| virtual BasicDoubleList | getAttenuationRange () const |
| Gets the attenuation range. More... | |
| virtual double | getAttenuationRes () const |
| Gets the attenuation resolution. More... | |
| virtual bool | isAgcSupported () const |
| Gets whether or not the tuner supports AGC. More... | |
| virtual bool | setFrequencyRangeMax (double freq) |
| Sets the maximum end of the tunable frequency range. 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 | executeFilterQuery (int index, int &filter) |
| Executes the tuner filter query command. More... | |
| virtual bool | executeTimingAdjustmentQuery (int index, int &timingAdj) |
| Executes the tuner timing adjustment query. 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 bool | executeFilterCommand (int index, int &filter) |
| Executes the tuner filter set command. More... | |
| virtual bool | executeTimingAdjustmentCommand (int index, int &timingAdj) |
| Executes the tuner timing adjustment 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. | |
Tuner component class for the NDR651.
Configuration dictionary elements:
Definition at line 47 of file TunerComponent.h.
| TunerComponent | ( | int | index = 1, |
| ::LibCyberRadio::Driver::RadioHandler * | parent = NULL, |
||
| bool | debug = false, |
||
| double | frequency = 800e6, |
||
| double | attenuation = 0.0, |
||
| int | filter = 0 |
||
| ) |
Constructs a TunerComponent object.
| 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. |
| frequency | Tuned frequency (Hz). |
| attenuation | Attenuation (dB). |
| filter | Filter setting. |
Definition at line 24 of file TunerComponent.cpp.
| TunerComponent | ( | const TunerComponent & | other | ) |
Copies a TunerComponent object.
| other | The TunerComponent object to copy. |
Definition at line 55 of file TunerComponent.cpp.
|
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.
| 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(). |
Definition at line 95 of file Debuggable.cpp.
|
virtualinherited |
Gets a debug output string for a Boolean value.
| x | Boolean value |
Definition at line 126 of file Debuggable.cpp.
|
virtualinherited |
Disables this component.
Definition at line 76 of file RadioComponent.cpp.
|
virtualinherited |
Enables this component.
| enabled | Whether or not this component should be enabled. |
Reimplemented from RadioComponent.
Definition at line 100 of file TunerComponent.cpp.
|
protectedvirtualinherited |
Executes the tuner attenuation set command.
| index | tuner index. |
| atten | Attenuation (dB). |
Reimplemented in TunerComponent, and TunerComponent.
Definition at line 516 of file TunerComponent.cpp.
|
protectedvirtualinherited |
Executes the tuner attenuation query command.
| index | tuner index. |
| atten | Attenuation (dB) (return). |
Reimplemented in TunerComponent.
Definition at line 410 of file TunerComponent.cpp.
|
protectedvirtualinherited |
Executes the tuner enable command.
| index | tuner index. |
| enabled | Whether or not tuner is enabled. |
Reimplemented in TunerComponent, and TunerComponent.
Definition at line 477 of file TunerComponent.cpp.
|
protectedvirtualinherited |
Executes the tuner enabled query command.
| index | tuner index. |
| enabled | Whether or not tuner is enabled (return). |
Reimplemented in TunerComponent.
Definition at line 363 of file TunerComponent.cpp.
|
protectedvirtualinherited |
Executes the tuner filter set command.
| index | tuner index. |
| filter | Filter setting. |
Reimplemented in TunerComponent.
Definition at line 536 of file TunerComponent.cpp.
|
protectedvirtualinherited |
Executes the tuner filter query command.
| index | tuner index. |
| filter | Filter setting (return). |
Reimplemented in TunerComponent.
Definition at line 433 of file TunerComponent.cpp.
|
protectedvirtualinherited |
Executes the tuner frequency set command.
| index | tuner index. |
| freq | Tuned frequency (Hz). |
Reimplemented in TunerComponent, and TunerComponent.
Definition at line 496 of file TunerComponent.cpp.
|
protectedvirtualinherited |
Executes the tuner frequency query command.
| index | tuner index. |
| freq | Tuned frequency (Hz) (return). |
Reimplemented in TunerComponent.
Definition at line 387 of file TunerComponent.cpp.
|
protectedvirtualinherited |
Executes the tuner timing adjustment command.
| index | tuner index. |
| timingAdj | Timing adjustment setting. |
Definition at line 554 of file TunerComponent.cpp.
|
protectedvirtualinherited |
Executes the tuner timing adjustment query.
| index | tuner index. |
| timingAdj | Timing adjustment setting (return). |
Reimplemented in TunerComponent.
Definition at line 455 of file TunerComponent.cpp.
|
virtualinherited |
Gets the attenuation.
Definition at line 220 of file TunerComponent.cpp.
|
virtualinherited |
Gets the attenuation range.
Definition at line 301 of file TunerComponent.cpp.
|
virtualinherited |
Gets the attenuation resolution.
Definition at line 309 of file TunerComponent.cpp.
|
virtualinherited |
Gets the configuration dictionary for this object.
Definition at line 93 of file Configurable.cpp.
|
virtualinherited |
Gets a named configuration value as a string.
| key | The key string in the configuration dictionary. |
Definition at line 98 of file Configurable.cpp.
|
virtualinherited |
Gets a named configuration value as a Boolean.
| key | The key string in the configuration dictionary. |
Definition at line 109 of file Configurable.cpp.
|
virtualinherited |
Gets a named configuration value as a double value.
| key | The key string in the configuration dictionary. |
Definition at line 148 of file Configurable.cpp.
|
virtualinherited |
Gets a named configuration value as an integer value.
| key | The key string in the configuration dictionary. |
Definition at line 122 of file Configurable.cpp.
|
virtualinherited |
Gets a named configuration value as an unsigned integer value.
| key | The key string in the configuration dictionary. |
Definition at line 135 of file Configurable.cpp.
|
virtualinherited |
Gets the debug name for this object.
Definition at line 138 of file Debuggable.cpp.
|
virtualinherited |
Gets the filter setting.
Definition at line 241 of file TunerComponent.cpp.
|
virtualinherited |
Gets the tuned frequency.
Definition at line 199 of file TunerComponent.cpp.
|
virtualinherited |
Gets the tunable frequency range.
Definition at line 283 of file TunerComponent.cpp.
|
virtualinherited |
Gets the tuned frequency resolution.
Definition at line 291 of file TunerComponent.cpp.
|
virtualinherited |
Gets the tuned frequency units.
Definition at line 296 of file TunerComponent.cpp.
|
virtualinherited |
Gets the index number of the component.
Definition at line 56 of file RadioComponent.cpp.
|
virtualinherited |
Gets the name of the configurable object.
Definition at line 83 of file Configurable.cpp.
|
virtualinherited |
Gets the "parent" radio handler for this component.
Definition at line 66 of file RadioComponent.cpp.
|
virtualinherited |
Gets the timing adjustment setting.
Definition at line 262 of file TunerComponent.cpp.
|
virtualinherited |
Gets whether or not the tuner supports AGC.
Definition at line 314 of file TunerComponent.cpp.
|
virtualinherited |
Gets whether this object produces debug output.
Definition at line 133 of file Debuggable.cpp.
|
virtualinherited |
Gets whether or not the component is enabled.
Definition at line 88 of file RadioComponent.cpp.
|
protectedvirtualinherited |
Normalizes a Boolean string value.
Definition at line 241 of file Configurable.cpp.
|
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").
Definition at line 232 of file Configurable.cpp.
|
virtual |
Assignment operator for TunerComponent objects.
| other | The TunerComponent object to copy. |
Definition at line 60 of file TunerComponent.cpp.
|
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.)
| data | Data string |
Definition at line 143 of file Debuggable.cpp.
|
virtualinherited |
Sets the attenuation.
| atten | The new attenuation (dB). |
Definition at line 225 of file TunerComponent.cpp.
|
virtualinherited |
Sets the configuration dictionary for this component.
| cfg | The component configuration dictionary. |
Reimplemented from RadioComponent.
Reimplemented in TunerComponent, and TunerComponent.
Definition at line 116 of file TunerComponent.cpp.
|
virtualinherited |
Sets a named configuration value to a string.
| key | The key string in the configuration dictionary. |
| value | The new value. |
Definition at line 177 of file Configurable.cpp.
|
virtualinherited |
Sets a named configuration value to a Boolean.
| key | The key string in the configuration dictionary. |
| value | The new value. |
Definition at line 193 of file Configurable.cpp.
|
virtualinherited |
Sets a named configuration value to a double value.
| key | The key string in the configuration dictionary. |
| value | The new value. |
Definition at line 211 of file Configurable.cpp.
|
virtualinherited |
Sets a named configuration value to an integer value.
| key | The key string in the configuration dictionary. |
| value | The new value. |
Definition at line 199 of file Configurable.cpp.
|
virtualinherited |
Sets a named configuration value to an unsigned integer value.
| key | The key string in the configuration dictionary. |
| value | The new value. |
Definition at line 205 of file Configurable.cpp.
|
virtualinherited |
Sets the debug file pointer for this object.
| debug_fp | File to send debug output to. |
Definition at line 81 of file Debuggable.cpp.
|
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.
| debug_name | Name for identifying this object in debug output. |
Definition at line 74 of file Debuggable.cpp.
|
virtualinherited |
Sets the debug time format for this object.
| 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.
|
virtualinherited |
Sets the filter setting.
| filter | The new filter setting. |
Definition at line 246 of file TunerComponent.cpp.
|
virtualinherited |
Sets the tuned frequency.
| freq | The new tuned frequency (Hz). |
Definition at line 204 of file TunerComponent.cpp.
|
virtualinherited |
Sets the maximum end of the tunable frequency range.
| freq | New maximum frequency (Hz). |
Definition at line 319 of file TunerComponent.cpp.
|
virtualinherited |
Sets the index number of the component.
| index | The index number. |
Definition at line 61 of file RadioComponent.cpp.
|
virtualinherited |
Sets the name of the configurable object.
| name | The new name. |
Definition at line 88 of file Configurable.cpp.
|
virtualinherited |
Sets the "parent" radio handler for this component.
| parent | A pointer to the RadioHandler object. |
Definition at line 71 of file RadioComponent.cpp.
|
virtualinherited |
Sets the timing adjustment setting.
| timingAdj | The new timing adjustment setting. |
Definition at line 267 of file TunerComponent.cpp.