libcyberradio  22.01.24
WbddcComponent Class Reference

WBDDC component class for the NDR472. More...

#include <WbddcComponent.h>

Inheritance diagram for WbddcComponent:
WbddcComponent RadioComponent Configurable Debuggable

Public Member Functions

 WbddcComponent (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)
 Constructs a WbddcComponent object. More...
 
virtual ~WbddcComponent ()
 Destroys a WbddcComponent object.
 
 WbddcComponent (const WbddcComponent &other)
 Copies a WbddcComponent object. More...
 
virtual WbddcComponentoperator= (const WbddcComponent &other)
 Assignment operator for WbddcComponent 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 WBDDC 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 bool isAgcSupported () const
 Gets whether or not the WBDDC supports AGC. More...
 
virtual bool isTunable () const
 Gets whether or not the WBDDC is tunable. More...
 
virtual bool isSourceSelectable () const
 Gets whether or not the WBDDC supports selectable source. More...
 
virtual int getSource () const
 Gets the WBDDC's source (which tuner is supplying the signal). More...
 
virtual bool setSource (int source)
 Sets the WBDDC's source (which tuner is supplying the signal). More...
 
virtual int getRateIndex () const
 Gets the WBDDC's rate index. More...
 
virtual bool setRateIndex (int index)
 Sets the WBDDC's rate index. More...
 
virtual int getUdpDestination () const
 Gets the WBDDC's UDP destination. More...
 
virtual bool setUdpDestination (int dest)
 Sets the WBDDC's UDP destination. More...
 
virtual int getVitaEnable () const
 Gets the WBDDC's VITA 49 setting. More...
 
virtual bool setVitaEnable (int enable)
 Sets the WBDDC's VITA 49 setting. More...
 
virtual unsigned int getStreamId () const
 Gets the WBDDC's VITA 49 stream ID. More...
 
virtual bool setStreamId (unsigned int sid)
 Sets the WBDDC's VITA 49 stream ID. More...
 
virtual int getDataPort () const
 Gets the WBDDC's data port. More...
 
virtual bool setDataPort (int port)
 Sets the WBDDC's data port. More...
 
virtual WbddcRateSet getRateSet () const
 Gets the WBDDC's rate set. More...
 
virtual bool setRateSet (const WbddcRateSet &set)
 Sets the WBDDC 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 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 bool executeWbddcQuery (int index, int &rateIndex, int &udpDestination, bool &enabled, int &vitaEnable, unsigned int &streamId)
 Executes the WBDDC configuration query command. More...
 
virtual bool executeDataPortQuery (int index, int &dataPort)
 Executes the WBDDC data port query command. More...
 
virtual bool executeDataPortCommand (int index, int &dataPort)
 Executes the WBDDC data port set command. More...
 
virtual void initConfigurationDict ()
 Initializes the configuration dictionary, defining the allowed keys.
 
virtual void updateConfigurationDict ()
 Updates the configuration dictionary from component settings.
 
virtual bool executeWbddcCommand (int index, int &rateIndex, int &udpDestination, bool &enabled, int &vitaEnable, unsigned int &streamId)
 Executes the WBDDC configuration set command. More...
 
virtual bool executeFreqQuery (int index, double &freq)
 Executes the WBDDC frequency query command. More...
 
virtual bool executeFreqCommand (int index, double &freq)
 Executes the WBDDC frequency set command. More...
 
virtual bool executeSourceQuery (int index, int &source)
 Executes the WBDDC source query command. More...
 
virtual bool executeSourceCommand (int index, int &source)
 Executes the WBDDC source 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

WBDDC component class for the NDR472.

Configuration dictionary elements:

  • "enable": Whether or not this DDC is enabled [Boolean/integer/string]
  • "rateIndex": Rate index [integer/string]
  • "udpDestination": UDP destination [integer/string]
  • "vitaEnable": VITA 49 framing setting [integer/string]
  • "streamId": VITA 49 streamId [integer/string]
  • "dataPort": Data port index [integer/string]

Definition at line 50 of file WbddcComponent.h.

Constructor & Destructor Documentation

◆ WbddcComponent() [1/2]

WbddcComponent ( 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 
)

Constructs a WbddcComponent object.

Parameters
indexThe index number of this component.
parentA pointer to the RadioHandler object that "owns" this component.
debugWhether the component supports debug output.
dataPortData port used by this WBDDC.
rateIndexWBDDC rate index. This should be one of the rate indices in the WBDDC's rate set.
udpDestinationUDP destination index.
vitaEnableVITA 49 framing setting (0-3).
streamIdVITA 49 stream ID.

Definition at line 26 of file WbddcComponent.cpp.

◆ WbddcComponent() [2/2]

WbddcComponent ( const WbddcComponent other)

Copies a WbddcComponent object.

Parameters
otherThe WbddcComponent object to copy.

Definition at line 65 of file WbddcComponent.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 112 of file WbddcComponent.cpp.

◆ executeDataPortCommand()

bool executeDataPortCommand ( int  index,
int &  dataPort 
)
protectedvirtual

Executes the WBDDC data port set command.

Parameters
indexWBDDC index.
dataPortWBDDC's data port.
Returns
True if the command succeeded, false otherwise. Returns false if the radio does not use data ports.

Reimplemented from WbddcComponent.

Definition at line 119 of file WbddcComponent.cpp.

◆ executeDataPortQuery()

bool executeDataPortQuery ( int  index,
int &  dataPort 
)
protectedvirtual

Executes the WBDDC data port 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
indexWBDDC index.
dataPortWBDDC's data port (return).
Returns
True if the command succeeded, false otherwise. Returns false if the radio does not use data ports.

Reimplemented from WbddcComponent.

Definition at line 111 of file WbddcComponent.cpp.

◆ executeFreqCommand()

bool executeFreqCommand ( int  index,
double &  freq 
)
protectedvirtualinherited

Executes the WBDDC frequency set command.

Parameters
indexWBDDC index.
freqWBDDC's tuned frequency.
Returns
True if the command succeeded, false otherwise. Returns false if the WBDDC is not tunable.

Reimplemented in WbddcComponent, and WbddcComponent.

Definition at line 598 of file WbddcComponent.cpp.

◆ executeFreqQuery()

bool executeFreqQuery ( int  index,
double &  freq 
)
protectedvirtualinherited

Executes the WBDDC frequency query command.

Note
The return value from this method only indicates if the command succeeded or failed. This method uses reference parameters to return the results of the query.
Parameters
indexWBDDC index.
freqWBDDC's tuned frequency (return).
Returns
True if the command succeeded, false otherwise. Returns false if the WBDDC is not tunable.

Definition at line 591 of file WbddcComponent.cpp.

◆ executeSourceCommand()

bool executeSourceCommand ( int  index,
int &  source 
)
protectedvirtualinherited

Executes the WBDDC source set command.

Parameters
indexWBDDC index.
sourceWBDDC's source index.
Returns
True if the command succeeded, false otherwise. Returns false if the WBDDC does not support selectable source.

Reimplemented in WbddcComponent, and WbddcComponent.

Definition at line 613 of file WbddcComponent.cpp.

◆ executeSourceQuery()

bool executeSourceQuery ( int  index,
int &  source 
)
protectedvirtualinherited

Executes the WBDDC source 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
indexWBDDC index.
sourceWBDDC's source index (return).
Returns
True if the command succeeded, false otherwise. Returns false if the WBDDC does not support selectable source.

Definition at line 605 of file WbddcComponent.cpp.

◆ executeWbddcCommand()

bool executeWbddcCommand ( int  index,
int &  rateIndex,
int &  udpDestination,
bool &  enabled,
int &  vitaEnable,
unsigned int &  streamId 
)
protectedvirtualinherited

Executes the WBDDC configuration set command.

Parameters
indexWBDDC index.
rateIndexWBDDC's rate index.
udpDestinationWBDDC's UDP destination.
enabledWhether or not WBDDC is enabled.
vitaEnableWBDDC's VITA 49 setting.
streamIdWBDDC's VITA 49 stream ID.
Returns
True if the command succeeded, false otherwise.

Reimplemented in WbddcComponent, and WbddcComponent.

Definition at line 565 of file WbddcComponent.cpp.

◆ executeWbddcQuery()

bool executeWbddcQuery ( int  index,
int &  rateIndex,
int &  udpDestination,
bool &  enabled,
int &  vitaEnable,
unsigned int &  streamId 
)
protectedvirtual

Executes the WBDDC configuration 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
indexWBDDC index.
rateIndexWBDDC's rate index (return).
udpDestinationWBDDC's UDP destination (return).
enabledWhether or not WBDDC is enabled (return).
vitaEnableWBDDC's VITA 49 setting (return).
streamIdWBDDC's VITA 49 stream ID (return).
Returns
True if the command succeeded, false otherwise.

Reimplemented from WbddcComponent.

Definition at line 81 of file WbddcComponent.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.

◆ getDataPort()

int getDataPort ( ) const
virtualinherited

Gets the WBDDC's data port.

Returns
The data port. This number has no meaning if the radio does not use data ports.

Definition at line 438 of file WbddcComponent.cpp.

◆ getDebugName()

std::string getDebugName ( ) const
virtualinherited

Gets the debug name for this object.

Returns
The debug name, as a string.

Definition at line 138 of file Debuggable.cpp.

◆ getFrequency()

double getFrequency ( ) const
virtualinherited

Gets the tuned frequency.

Returns
The tuned frequency, in Hz. This value has no meaning if the WBDDC is not tunable.

Definition at line 263 of file WbddcComponent.cpp.

◆ getFrequencyRange()

BasicDoubleList getFrequencyRange ( ) const
virtualinherited

Gets the tunable frequency range.

Returns
A list containing the minimum and maximum frequencies. These numbers have no meaning if the WBDDC is not tunable.

Definition at line 284 of file WbddcComponent.cpp.

◆ getFrequencyRes()

double getFrequencyRes ( ) const
virtualinherited

Gets the tuned frequency resolution.

Returns
The frequency resolution, in Hz. This value has no meaning if the WBDDC is not tunable.

Definition at line 292 of file WbddcComponent.cpp.

◆ getFrequencyUnit()

double getFrequencyUnit ( ) const
virtualinherited

Gets the tuned frequency units.

Returns
The frequency units, in Hz. This value has no meaning if the WBDDC is not tunable.

Definition at line 297 of file WbddcComponent.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.

◆ getRateIndex()

int getRateIndex ( ) const
virtualinherited

Gets the WBDDC's rate index.

Returns
The rate index.

Definition at line 338 of file WbddcComponent.cpp.

◆ getRateList()

BasicDoubleList getRateList ( ) const
virtualinherited

Gets the list of allowed sample rates, based on the rate set.

Returns
The rate list.

Definition at line 470 of file WbddcComponent.cpp.

◆ getRateSet()

WbddcRateSet getRateSet ( ) const
virtualinherited

Gets the WBDDC's rate set.

Returns
The rate set.

Definition at line 459 of file WbddcComponent.cpp.

◆ getSource()

int getSource ( ) const
virtualinherited

Gets the WBDDC's source (which tuner is supplying the signal).

Returns
The source index. This value has no meaning if the WBDDC does not support selectable source.

Definition at line 317 of file WbddcComponent.cpp.

◆ getStreamId()

unsigned int getStreamId ( ) const
virtualinherited

Gets the WBDDC's VITA 49 stream ID.

Returns
The VITA 49 stream ID.

Definition at line 413 of file WbddcComponent.cpp.

◆ getUdpDestination()

int getUdpDestination ( ) const
virtualinherited

Gets the WBDDC's UDP destination.

Returns
The UDP destination.

Definition at line 363 of file WbddcComponent.cpp.

◆ getVitaEnable()

int getVitaEnable ( ) const
virtualinherited

Gets the WBDDC's VITA 49 setting.

Returns
The VITA 49 setting.

Definition at line 388 of file WbddcComponent.cpp.

◆ isAgcSupported()

bool isAgcSupported ( ) const
virtualinherited

Gets whether or not the WBDDC supports AGC.

Returns
True if supported, false otherwise.

Definition at line 302 of file WbddcComponent.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.

◆ isSourceSelectable()

bool isSourceSelectable ( ) const
virtualinherited

Gets whether or not the WBDDC supports selectable source.

Returns
True if supported, false otherwise.

Definition at line 312 of file WbddcComponent.cpp.

◆ isTunable()

bool isTunable ( ) const
virtualinherited

Gets whether or not the WBDDC is tunable.

Returns
True if tunable, false otherwise.

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

WbddcComponent & operator= ( const WbddcComponent other)
virtual

Assignment operator for WbddcComponent objects.

Parameters
otherThe WbddcComponent object to copy.
Returns
A reference to the assigned object.

Definition at line 70 of file WbddcComponent.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.

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

Reimplemented in WbddcComponent, and WbddcComponent.

Definition at line 132 of file WbddcComponent.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.

◆ setDataPort()

bool setDataPort ( int  port)
virtualinherited

Sets the WBDDC's data port.

Parameters
portThe new data port.
Returns
True if successful, false otherwise. Returns false if the radio does not use data ports.

Definition at line 443 of file WbddcComponent.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 WBDDC tuned frequency.

Parameters
freqThe new tuned frequency (Hz).
Returns
True if successful, false otherwise. Returns false if the WBDDC is not tunable.

Reimplemented in WbddcComponent, and WbddcComponent.

Definition at line 268 of file WbddcComponent.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.

◆ setRateIndex()

bool setRateIndex ( int  index)
virtualinherited

Sets the WBDDC's rate index.

Parameters
indexThe new rate index.
Returns
True if successful, false otherwise.

Reimplemented in WbddcComponent, and WbddcComponent.

Definition at line 343 of file WbddcComponent.cpp.

◆ setRateSet()

bool setRateSet ( const WbddcRateSet set)
virtualinherited

Sets the WBDDC rate set.

Parameters
setThe new rate set.
Returns
True if successful, false otherwise.

Definition at line 464 of file WbddcComponent.cpp.

◆ setSource()

bool setSource ( int  source)
virtualinherited

Sets the WBDDC's source (which tuner is supplying the signal).

Parameters
sourceThe new WBDDC source index.
Returns
True if successful, false otherwise. Returns false if the WBDDC does not support selectable source.

Reimplemented in WbddcComponent, and WbddcComponent.

Definition at line 322 of file WbddcComponent.cpp.

◆ setStreamId()

bool setStreamId ( unsigned int  sid)
virtualinherited

Sets the WBDDC's VITA 49 stream ID.

Parameters
sidThe new stream ID.
Returns
True if successful, false otherwise.

Definition at line 418 of file WbddcComponent.cpp.

◆ setUdpDestination()

bool setUdpDestination ( int  dest)
virtualinherited

Sets the WBDDC's UDP destination.

Parameters
destThe new UDP destination.
Returns
True if successful, false otherwise.

Reimplemented in WbddcComponent, and WbddcComponent.

Definition at line 368 of file WbddcComponent.cpp.

◆ setVitaEnable()

bool setVitaEnable ( int  enable)
virtualinherited

Sets the WBDDC's VITA 49 setting.

Parameters
enableThe new VITA 49 setting.
Returns
True if successful, false otherwise.

Definition at line 393 of file WbddcComponent.cpp.


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