![]() |
libcyberradio
22.01.24
|
NBDDC component class for the NDR551. More...
#include <NbddcComponent.h>
Public Member Functions | |
| NbddcComponent (int index=1, ::LibCyberRadio::Driver::RadioHandler *parent=NULL, bool debug=false, int dataPort=1, int rateIndex=0, int udpDestination=0, int vitaEnable=0, int streamId=0, double frequency=0.0, int source=1) | |
| Constructs a NbddcComponent object. More... | |
| virtual | ~NbddcComponent () |
| Destroys a NbddcComponent object. | |
| NbddcComponent (const NbddcComponent &other) | |
| Copies a NbddcComponent object. More... | |
| virtual NbddcComponent & | operator= (const NbddcComponent &other) |
| Assignment operator for NbddcComponent objects. More... | |
| void | initConfigurationDict () override |
| Setup Config Dict. | |
| bool | executeNbddcQuery (int index, int &rateIndex, int &udpDestination, bool &enabled, int &vitaEnable, unsigned int &streamId, double &frequency, int &source) override |
| Executes the NBDDC configuration query command. More... | |
| void | queryConfiguration () override |
| Tells the component to query its hardware configuration in order to create its configuration dictionary. | |
| bool | executeSourceCommand (int index, int &source) override |
| Executes the NBDDC source set command. More... | |
| bool | executeFreqCommand (int index, double &freq) override |
| Executes the NBDDC frequency set command. More... | |
| bool | executeNbddcCommand (int index, int &rateIndex, int &udpDestination, bool &enabled, int &vitaEnable, unsigned int &streamId, double &frequency, int &source) override |
| Executes the NBDDC configuration set command. More... | |
| void | updateConfigurationDict () override |
| Updates the configuration dictionary from component settings. | |
| virtual bool | enable (bool enabled=true) |
| Enables this component. More... | |
| virtual bool | setConfiguration (ConfigurationDict &cfg) |
| Sets the configuration dictionary for this component. More... | |
| virtual double | getFrequency () const |
| Gets the tuned frequency. More... | |
| virtual bool | setFrequency (double freq) |
| Sets the NBDDC tuned frequency. 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 int | getSource () const |
| Gets the NBDDC's source (which tuner is supplying the signal). More... | |
| virtual bool | setSource (int source) |
| Sets the NBDDC's source (which tuner is supplying the signal). More... | |
| virtual int | getRateIndex () const |
| Gets the NBDDC's rate index. More... | |
| virtual bool | setRateIndex (int index) |
| Sets the NBDDC's rate index. More... | |
| virtual int | getUdpDestination () const |
| Gets the NBDDC's UDP destination. More... | |
| virtual bool | setUdpDestination (int dest) |
| Sets the NBDDC's UDP destination. More... | |
| virtual int | getVitaEnable () const |
| Gets the NBDDC's VITA 49 setting. More... | |
| virtual bool | setVitaEnable (int enable) |
| Sets the NBDDC's VITA 49 setting. More... | |
| virtual unsigned int | getStreamId () const |
| Gets the NBDDC's VITA 49 stream ID. More... | |
| virtual bool | setStreamId (unsigned int sid) |
| Sets the NBDDC's VITA 49 stream ID. More... | |
| virtual int | getDataPort () const |
| Gets the NBDDC's data port. More... | |
| virtual bool | setDataPort (int port) |
| Sets the NBDDC's data port. More... | |
| virtual NbddcRateSet | getRateSet () const |
| Gets the NBDDC's rate set. More... | |
| virtual bool | setRateSet (const NbddcRateSet &set) |
| Sets the NBDDC rate set. More... | |
| virtual BasicDoubleList | getRateList () const |
| Gets the list of allowed sample rates, based on the rate set. 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 bool | executeFreqQuery (int index, double &freq) |
| Executes the NBDDC frequency query command. More... | |
| virtual bool | executeSourceQuery (int index, int &source) |
| Executes the NBDDC source query command. More... | |
| virtual bool | executeDataPortQuery (int index, int &dataPort) |
| Executes the NBDDC data port query command. More... | |
| virtual bool | executeDataPortCommand (int index, int &dataPort) |
| Executes the NBDDC data port 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. | |
NBDDC component class for the NDR551.
Configuration dictionary elements:
Definition at line 52 of file NbddcComponent.h.
| NbddcComponent | ( | int | index = 1, |
| ::LibCyberRadio::Driver::RadioHandler * | parent = NULL, |
||
| bool | debug = false, |
||
| int | dataPort = 1, |
||
| int | rateIndex = 0, |
||
| int | udpDestination = 0, |
||
| int | vitaEnable = 0, |
||
| int | streamId = 0, |
||
| double | frequency = 0.0, |
||
| int | source = 1 |
||
| ) |
Constructs a NbddcComponent 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. |
| dataPort | Data port used by this NBDDC. |
| rateIndex | NBDDC rate index. This should be one of the rate indices in the NBDDC's rate set. |
| udpDestination | UDP destination index. |
| vitaEnable | VITA 49 framing setting (0-3). |
| streamId | VITA 49 stream ID. |
| frequency | Tuned frequency (Hz). |
| source | Source (tuner) index supplying the signal for this NBDDC. |
Definition at line 26 of file NbddcComponent.cpp.
| NbddcComponent | ( | const NbddcComponent & | other | ) |
Copies a NbddcComponent object.
| other | The NbddcComponent object to copy. |
Definition at line 81 of file NbddcComponent.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 108 of file NbddcComponent.cpp.
|
protectedvirtualinherited |
Executes the NBDDC data port set command.
| index | NBDDC index. |
| dataPort | NBDDC's data port. |
Definition at line 701 of file NbddcComponent.cpp.
|
protectedvirtualinherited |
Executes the NBDDC data port query command.
| index | NBDDC index. |
| dataPort | NBDDC's data port (return). |
Definition at line 677 of file NbddcComponent.cpp.
|
overridevirtual |
Executes the NBDDC frequency set command.
| index | NBDDC index. |
| freq | NBDDC's tuned frequency. |
Reimplemented from NbddcComponent.
Definition at line 248 of file NbddcComponent.cpp.
|
protectedvirtualinherited |
Executes the NBDDC frequency query command.
| index | NBDDC index. |
| freq | NBDDC's tuned frequency (return). |
Definition at line 619 of file NbddcComponent.cpp.
|
overridevirtual |
Executes the NBDDC configuration set command.
| index | NBDDC index. |
| rateIndex | NBDDC's rate index. |
| udpDestination | NBDDC's UDP destination. |
| enabled | Whether or not NBDDC is enabled. |
| vitaEnable | NBDDC's VITA 49 setting. |
| streamId | NBDDC's VITA 49 stream ID. |
| frequency | NBDDC's frequency. |
| source | NBDDC's source. |
Reimplemented from NbddcComponent.
Definition at line 274 of file NbddcComponent.cpp.
|
overridevirtual |
Executes the NBDDC configuration query command.
| index | NBDDC index. |
| rateIndex | NBDDC's rate index (return). |
| udpDestination | NBDDC's UDP destination (return). |
| enabled | Whether or not NBDDC is enabled (return). |
| vitaEnable | NBDDC's VITA 49 setting (return). |
| streamId | NBDDC's VITA 49 stream ID (return). |
| frequency | NBDDC's frequency (return). |
| source | NBDDC's source (return). |
Reimplemented from NbddcComponent.
Definition at line 185 of file NbddcComponent.cpp.
|
overridevirtual |
Executes the NBDDC source set command.
| index | NBDDC index. |
| source | NBDDC's source index. |
Reimplemented from NbddcComponent.
Definition at line 222 of file NbddcComponent.cpp.
|
protectedvirtualinherited |
Executes the NBDDC source query command.
| index | NBDDC index. |
| source | NBDDC's source index (return). |
Definition at line 633 of file NbddcComponent.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 NBDDC's data port.
Definition at line 465 of file NbddcComponent.cpp.
|
virtualinherited |
Gets the debug name for this object.
Definition at line 138 of file Debuggable.cpp.
|
virtualinherited |
Gets the tuned frequency.
Definition at line 261 of file NbddcComponent.cpp.
|
virtualinherited |
Gets the tunable frequency range.
Definition at line 296 of file NbddcComponent.cpp.
|
virtualinherited |
Gets the tuned frequency resolution.
Definition at line 304 of file NbddcComponent.cpp.
|
virtualinherited |
Gets the tuned frequency units.
Definition at line 309 of file NbddcComponent.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 NBDDC's rate index.
Definition at line 349 of file NbddcComponent.cpp.
|
virtualinherited |
Gets the list of allowed sample rates, based on the rate set.
Definition at line 497 of file NbddcComponent.cpp.
|
virtualinherited |
|
virtualinherited |
Gets the NBDDC's source (which tuner is supplying the signal).
Definition at line 314 of file NbddcComponent.cpp.
|
virtualinherited |
Gets the NBDDC's VITA 49 stream ID.
Definition at line 436 of file NbddcComponent.cpp.
|
virtualinherited |
Gets the NBDDC's UDP destination.
Definition at line 378 of file NbddcComponent.cpp.
|
virtualinherited |
Gets the NBDDC's VITA 49 setting.
Definition at line 407 of file NbddcComponent.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 NbddcComponent objects.
| other | The NbddcComponent object to copy. |
Definition at line 86 of file NbddcComponent.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 configuration dictionary for this component.
| cfg | The component configuration dictionary. |
Reimplemented from RadioComponent.
Definition at line 131 of file NbddcComponent.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 NBDDC's data port.
| port | The new data port. |
Definition at line 470 of file NbddcComponent.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 NBDDC tuned frequency.
| freq | The new tuned frequency (Hz). |
Definition at line 266 of file NbddcComponent.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 NBDDC's rate index.
| index | The new rate index. |
Definition at line 354 of file NbddcComponent.cpp.
|
virtualinherited |
Sets the NBDDC rate set.
| set | The new rate set. |
Definition at line 491 of file NbddcComponent.cpp.
|
virtualinherited |
Sets the NBDDC's source (which tuner is supplying the signal).
| source | The new NBDDC source index. |
Definition at line 319 of file NbddcComponent.cpp.
|
virtualinherited |
Sets the NBDDC's VITA 49 stream ID.
| sid | The new stream ID. |
Definition at line 441 of file NbddcComponent.cpp.
|
virtualinherited |
Sets the NBDDC's UDP destination.
| dest | The new UDP destination. |
Definition at line 383 of file NbddcComponent.cpp.
|
virtualinherited |
Sets the NBDDC's VITA 49 setting.
| enable | The new VITA 49 setting. |
Definition at line 412 of file NbddcComponent.cpp.