NBDDC component class for the NDR651. More...

#include <NbddcComponent.h>

Inheritance diagram for NbddcComponent:

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

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 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 void	initConfigurationDict ()
	Initializes the configuration dictionary, defining the allowed keys.

virtual void	updateConfigurationDict ()
	Updates the configuration dictionary from component settings.

virtual bool	executeNbddcQuery (int index, int &rateIndex, int &udpDestination, bool &enabled, int &vitaEnable, unsigned int &streamId, double &frequency, int &source)
	Executes the NBDDC configuration query command. More...

virtual bool	executeNbddcCommand (int index, int &rateIndex, int &udpDestination, bool &enabled, int &vitaEnable, unsigned int &streamId, double &frequency, int &source)
	Executes the NBDDC configuration set command. More...

virtual bool	executeFreqQuery (int index, double &freq)
	Executes the NBDDC frequency query command. More...

virtual bool	executeFreqCommand (int index, double &freq)
	Executes the NBDDC frequency set command. More...

virtual bool	executeSourceQuery (int index, int &source)
	Executes the NBDDC source query command. More...

virtual bool	executeSourceCommand (int index, int &source)
	Executes the NBDDC source set 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.

Detailed Description

NBDDC component class for the NDR651.

Configuration dictionary elements:

"enable": Whether or not this DDC is enabled [Boolean]
"rateIndex": Rate index [integer]
"udpDestination": UDP destination [integer, meaning varies by radio]
"vitaEnable": VITA 49 framing setting [integer, meaning varies by radio]
"streamId": VITA 49 streamId [integer]
"frequency": Tuned frequency (Hz) [double]
"source": Source tuner index [integer]
"dataPort": Data port index [integer]

Definition at line 52 of file NbddcComponent.h.

Constructor & Destructor Documentation

◆ NbddcComponent() [1/2]

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.

Parameters

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 25 of file NbddcComponent.cpp.

◆ NbddcComponent() [2/2]

NbddcComponent ( const NbddcComponent & other )

Copies a NbddcComponent object.

Parameters

other The NbddcComponent object to copy.

Definition at line 72 of file NbddcComponent.cpp.

Member Function Documentation

◆ debug()

int debug	(	const char *	format,
			...
	)

virtualinherited

Outputs debug information.

This method follows the same semantics as printf(). Output is preceded by a timestamp and the name of the object, if provided.

Parameters

format	The printf()-style format string.
...	Comma-separated list of arguments to print. Note that these need to be arguments that can be supported natively through printf().

Returns: The number of characters outputted.

Definition at line 95 of file Debuggable.cpp.

◆ debugBool()

const char * debugBool ( bool x )

virtualinherited

Gets a debug output string for a Boolean value.

Parameters

x	Boolean value

Returns: A constant string, either "true" or "false".

Definition at line 126 of file Debuggable.cpp.

◆ disable()

bool disable ( )

virtualinherited

Disables this component.

Returns: True if successful, false otherwise.

Definition at line 76 of file RadioComponent.cpp.

◆ enable()

bool enable ( bool enabled = true )

virtualinherited

Enables this component.

Parameters

enabled Whether or not this component should be enabled.

Returns: True if successful, false otherwise.

Reimplemented from RadioComponent.

Definition at line 108 of file NbddcComponent.cpp.

◆ executeDataPortCommand()

bool executeDataPortCommand	(	int	index,
		int &	dataPort
	)

protectedvirtualinherited

Executes the NBDDC data port set command.

Parameters

index	NBDDC index.
dataPort	NBDDC's data port.

Returns: True if the command succeeded, false otherwise. Returns false if the radio does not use data ports.

Definition at line 701 of file NbddcComponent.cpp.

◆ executeDataPortQuery()

bool executeDataPortQuery	(	int	index,
		int &	dataPort
	)

protectedvirtualinherited

Executes the NBDDC 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

index	NBDDC index.
dataPort	NBDDC's data port (return).

Returns: True if the command succeeded, false otherwise. Returns false if the radio does not use data ports.

Definition at line 677 of file NbddcComponent.cpp.

◆ executeFreqCommand()

bool executeFreqCommand	(	int	index,
		double &	freq
	)

protectedvirtualinherited

Executes the NBDDC frequency set command.

Parameters

index	NBDDC index.
freq	NBDDC's tuned frequency.

Returns: True if the command succeeded, false otherwise. Returns false if the NBDDC is not tunable.

Reimplemented in NbddcComponent.

Definition at line 626 of file NbddcComponent.cpp.

◆ executeFreqQuery()

bool executeFreqQuery	(	int	index,
		double &	freq
	)

protectedvirtualinherited

Executes the NBDDC 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

index	NBDDC index.
freq	NBDDC's tuned frequency (return).

Returns: True if the command succeeded, false otherwise. Returns false if the NBDDC is not tunable.

Definition at line 619 of file NbddcComponent.cpp.

◆ executeNbddcCommand()

bool executeNbddcCommand	(	int	index,
		int &	rateIndex,
		int &	udpDestination,
		bool &	enabled,
		int &	vitaEnable,
		unsigned int &	streamId,
		double &	frequency,
		int &	source
	)

protectedvirtualinherited

Executes the NBDDC configuration set command.

Note: Because the NBDDC configuration command varies between radios, this method may not use all of the parameters passed to it.

Parameters

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.

Returns: True if the command succeeded, false otherwise.

Reimplemented in NbddcComponent.

Definition at line 587 of file NbddcComponent.cpp.

◆ executeNbddcQuery()

bool executeNbddcQuery	(	int	index,
		int &	rateIndex,
		int &	udpDestination,
		bool &	enabled,
		int &	vitaEnable,
		unsigned int &	streamId,
		double &	frequency,
		int &	source
	)

protectedvirtualinherited

Executes the NBDDC 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.; Because the NBDDC configuration query varies between radios, this method may not use all of the parameters passed to it.

Parameters

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

Returns: True if the command succeeded, false otherwise.

Reimplemented in NbddcComponent.

Definition at line 548 of file NbddcComponent.cpp.

◆ executeSourceCommand()

bool executeSourceCommand	(	int	index,
		int &	source
	)

protectedvirtualinherited

Executes the NBDDC source set command.

Parameters

index	NBDDC index.
source	NBDDC's source index.

Returns: True if the command succeeded, false otherwise. Returns false if the NBDDC does not support selectable source.

Reimplemented in NbddcComponent.

Definition at line 657 of file NbddcComponent.cpp.

◆ executeSourceQuery()

bool executeSourceQuery	(	int	index,
		int &	source
	)

protectedvirtualinherited

Executes the NBDDC 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

index	NBDDC index.
source	NBDDC's source index (return).

Returns: True if the command succeeded, false otherwise. Returns false if the NBDDC does not support selectable source.

Definition at line 633 of file NbddcComponent.cpp.

◆ getConfiguration()

ConfigurationDict getConfiguration ( ) const

virtualinherited

Gets the configuration dictionary for this object.

Returns: The configuration dictionary.

Definition at line 93 of file Configurable.cpp.

◆ getConfigurationValue()

ConfigString getConfigurationValue ( const std::string & key ) const

virtualinherited

Gets a named configuration value as a string.

Parameters

key	The key string in the configuration dictionary.

Returns: The value represented by this key. Returns an empty string if the key is not in the configuration dictionary.

Definition at line 98 of file Configurable.cpp.

◆ getConfigurationValueAsBool()

bool getConfigurationValueAsBool ( const std::string & key ) const

virtualinherited

Gets a named configuration value as a Boolean.

Parameters

key	The key string in the configuration dictionary.

Returns: The Boolean value represented by this key. Returns false if the key is not in the configuration dictionary, or cannot be represented as a Boolean.

Definition at line 109 of file Configurable.cpp.

◆ getConfigurationValueAsDbl()

double getConfigurationValueAsDbl ( const std::string & key ) const

virtualinherited

Gets a named configuration value as a double value.

Parameters

key	The key string in the configuration dictionary.

Returns: The double value represented by this key. Returns 0.0 if the key is not in the configuration dictionary, or if the value cannot be represented as a double.

Definition at line 148 of file Configurable.cpp.

◆ getConfigurationValueAsInt()

int getConfigurationValueAsInt ( const std::string & key ) const

virtualinherited

Gets a named configuration value as an integer value.

Parameters

key	The key string in the configuration dictionary.

Returns: The integer value represented by this key. Returns 0 if the key is not in the configuration dictionary, or if the value cannot be represented as an integer.

Definition at line 122 of file Configurable.cpp.

◆ getConfigurationValueAsUInt()

unsigned int getConfigurationValueAsUInt ( const std::string & key ) const

virtualinherited

Gets a named configuration value as an unsigned integer value.

Parameters

key	The key string in the configuration dictionary.

Returns: The integer value represented by this key. Returns 0 if the key is not in the configuration dictionary, or if the value cannot be represented as an integer.

Definition at line 135 of file Configurable.cpp.

◆ getDataPort()

int getDataPort ( ) const

virtualinherited

Gets the NBDDC's data port.

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

Definition at line 465 of file NbddcComponent.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 NBDDC is not tunable.

Definition at line 261 of file NbddcComponent.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 NBDDC is not tunable.

Definition at line 296 of file NbddcComponent.cpp.

◆ getFrequencyRes()

double getFrequencyRes ( ) const

virtualinherited

Gets the tuned frequency resolution.

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

Definition at line 304 of file NbddcComponent.cpp.

◆ getFrequencyUnit()

double getFrequencyUnit ( ) const

virtualinherited

Gets the tuned frequency units.

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

Definition at line 309 of file NbddcComponent.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 NBDDC's rate index.

Returns: The rate index.

Definition at line 349 of file NbddcComponent.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 497 of file NbddcComponent.cpp.

◆ getRateSet()

NbddcRateSet getRateSet ( ) const

virtualinherited

Gets the NBDDC's rate set.

Returns: The rate set.

Definition at line 486 of file NbddcComponent.cpp.

◆ getSource()

int getSource ( ) const

virtualinherited

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

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

Definition at line 314 of file NbddcComponent.cpp.

◆ getStreamId()

unsigned int getStreamId ( ) const

virtualinherited

Gets the NBDDC's VITA 49 stream ID.

Returns: The VITA 49 stream ID.

Definition at line 436 of file NbddcComponent.cpp.

◆ getUdpDestination()

int getUdpDestination ( ) const

virtualinherited

Gets the NBDDC's UDP destination.

Returns: The UDP destination.

Definition at line 378 of file NbddcComponent.cpp.

◆ getVitaEnable()

int getVitaEnable ( ) const

virtualinherited

Gets the NBDDC's VITA 49 setting.

Returns: The VITA 49 setting.

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

NbddcComponent & operator= ( const NbddcComponent & other )

virtual

Assignment operator for NbddcComponent objects.

Parameters

other The NbddcComponent object to copy.

Returns: A reference to the assigned object.

Definition at line 77 of file NbddcComponent.cpp.

◆ rawString()

std::string rawString ( const std::string & data )

virtualinherited

Gets a "raw" string representation of a given data string.

"Raw" string representations mimic Python string representations. Whitespace characters are denoted by backslash representations ("\\r", "\\n", "\\t", "\\v", "\\f"), while other non-printable characters are represented with hex representation ("\\x00", etc.)

Parameters

data	Data string

Returns: The data's "raw" representation.

Definition at line 143 of file Debuggable.cpp.

◆ setConfiguration()

bool setConfiguration ( ConfigurationDict & cfg )

virtualinherited

Sets the configuration dictionary for this component.

Parameters

cfg	The component configuration dictionary.

Returns: True if successful, false otherwise.

Reimplemented from RadioComponent.

Definition at line 131 of file NbddcComponent.cpp.

◆ setConfigurationValue()

bool setConfigurationValue	(	const std::string &	key,
		const std::string &	value
	)

virtualinherited

Sets a named configuration value to a string.

Note: The default behavior of this method is to normalize the incoming value.

Parameters

key	The key string in the configuration dictionary.
value	The new value.

Returns: True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 177 of file Configurable.cpp.

◆ setConfigurationValueToBool()

bool setConfigurationValueToBool	(	const std::string &	key,
		const bool	value
	)

virtualinherited

Sets a named configuration value to a Boolean.

Parameters

key	The key string in the configuration dictionary.
value	The new value.

Returns: True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 193 of file Configurable.cpp.

◆ setConfigurationValueToDbl()

bool setConfigurationValueToDbl	(	const std::string &	key,
		const double	value
	)

virtualinherited

Sets a named configuration value to a double value.

Parameters

key	The key string in the configuration dictionary.
value	The new value.

Returns: True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 211 of file Configurable.cpp.

◆ setConfigurationValueToInt()

bool setConfigurationValueToInt	(	const std::string &	key,
		const int	value
	)

virtualinherited

Sets a named configuration value to an integer value.

Parameters

key	The key string in the configuration dictionary.
value	The new value.

Returns: True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 199 of file Configurable.cpp.

◆ setConfigurationValueToUInt()

bool setConfigurationValueToUInt	(	const std::string &	key,
		const unsigned int	value
	)

virtualinherited

Sets a named configuration value to an unsigned integer value.

Parameters

key	The key string in the configuration dictionary.
value	The new value.

Returns: True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 205 of file Configurable.cpp.

◆ setDataPort()

bool setDataPort ( int port )

virtualinherited

Sets the NBDDC's data port.

Parameters

port	The new data port.

Returns: True if successful, false otherwise. Returns false if the radio does not use data ports.

Definition at line 470 of file NbddcComponent.cpp.

◆ setDebugFile()

void setDebugFile ( FILE * debug_fp )

virtualinherited

Sets the debug file pointer for this object.

Parameters

debug_fp File to send debug output to.

Definition at line 81 of file Debuggable.cpp.

◆ setDebugName()

void setDebugName ( const std::string & debug_name )

virtualinherited

Sets the debug name for this object.

Use this method to set unique debug names for objects of the same class for easy differentiation.

Parameters

debug_name Name for identifying this object in debug output.

Definition at line 74 of file Debuggable.cpp.

◆ setDebugTimeFormat()

void setDebugTimeFormat ( const std::string & debug_timefmt )

virtualinherited

Sets the debug time format for this object.

Parameters

debug_timefmt Format string for displaying timestamp, as compatible with strftime(). If this is an empty string, don't display a timestamp.

Definition at line 88 of file Debuggable.cpp.

◆ setFrequency()

bool setFrequency ( double freq )

virtualinherited

Sets the NBDDC tuned frequency.

Parameters

freq	The new tuned frequency (Hz).

Returns: True if successful, false otherwise. Returns false if the NBDDC is not tunable.

Definition at line 266 of file NbddcComponent.cpp.

◆ setIndex()

void setIndex ( int index )

virtualinherited

Sets the index number of the component.

Parameters

index The index number.

Definition at line 61 of file RadioComponent.cpp.

◆ setName()

void setName ( const std::string & name )

virtualinherited

Sets the name of the configurable object.

Parameters

name	The new name.

Definition at line 88 of file Configurable.cpp.

◆ setParent()

void setParent ( RadioHandler * parent )

virtualinherited

Sets the "parent" radio handler for this component.

Parameters

parent A pointer to the RadioHandler object.

Definition at line 71 of file RadioComponent.cpp.

◆ setRateIndex()

bool setRateIndex ( int index )

virtualinherited

Sets the NBDDC's rate index.

Parameters

index The new rate index.

Returns: True if successful, false otherwise.

Definition at line 354 of file NbddcComponent.cpp.

◆ setRateSet()

bool setRateSet ( const NbddcRateSet & set )

virtualinherited

Sets the NBDDC rate set.

Parameters

set	The new rate set.

Returns: True if successful, false otherwise.

Definition at line 491 of file NbddcComponent.cpp.

◆ setSource()

bool setSource ( int source )

virtualinherited

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

Parameters

source The new NBDDC source index.

Returns: True if successful, false otherwise. Returns false if the NBDDC does not support selectable source.

Definition at line 319 of file NbddcComponent.cpp.

◆ setStreamId()

bool setStreamId ( unsigned int sid )

virtualinherited

Sets the NBDDC's VITA 49 stream ID.

Parameters

sid	The new stream ID.

Returns: True if successful, false otherwise.

Definition at line 441 of file NbddcComponent.cpp.

◆ setUdpDestination()

bool setUdpDestination ( int dest )

virtualinherited

Sets the NBDDC's UDP destination.

Parameters

dest	The new UDP destination.

Returns: True if successful, false otherwise.

Definition at line 383 of file NbddcComponent.cpp.

◆ setVitaEnable()

bool setVitaEnable ( int enable )

virtualinherited

Sets the NBDDC's VITA 49 setting.

Parameters

enable The new VITA 49 setting.

Returns: True if successful, false otherwise.

Definition at line 412 of file NbddcComponent.cpp.

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NbddcComponent() [1/2]

◆ NbddcComponent() [2/2]

Member Function Documentation

◆ debug()

◆ debugBool()

◆ disable()

◆ enable()

◆ executeDataPortCommand()

◆ executeDataPortQuery()

◆ executeFreqCommand()

◆ executeFreqQuery()

◆ executeNbddcCommand()

◆ executeNbddcQuery()

◆ executeSourceCommand()

◆ executeSourceQuery()

◆ getConfiguration()

◆ getConfigurationValue()

◆ getConfigurationValueAsBool()

◆ getConfigurationValueAsDbl()

◆ getConfigurationValueAsInt()

◆ getConfigurationValueAsUInt()

◆ getDataPort()

◆ getDebugName()

◆ getFrequency()

◆ getFrequencyRange()

◆ getFrequencyRes()

◆ getFrequencyUnit()

◆ getIndex()

◆ getName()

◆ getParent()

◆ getRateIndex()

◆ getRateList()

◆ getRateSet()

◆ getSource()

◆ getStreamId()

◆ getUdpDestination()

◆ getVitaEnable()

◆ isDebug()

◆ isEnabled()

◆ normalizedBool()

◆ normalizedConfigurationDict()

◆ operator=()

◆ rawString()

◆ setConfiguration()

◆ setConfigurationValue()

◆ setConfigurationValueToBool()

◆ setConfigurationValueToDbl()

◆ setConfigurationValueToInt()

◆ setConfigurationValueToUInt()

◆ setDataPort()

◆ setDebugFile()

◆ setDebugName()

◆ setDebugTimeFormat()

◆ setFrequency()

◆ setIndex()

◆ setName()

◆ setParent()

◆ setRateIndex()

◆ setRateSet()

◆ setSource()

◆ setStreamId()

◆ setUdpDestination()

◆ setVitaEnable()