Base configurable object class. More...

#include <Configurable.h>

Inheritance diagram for Configurable:

Public Member Functions
	Configurable (const std::string &name="<unknown>", bool debug=false)
	Constructs a Configurable object. More...

virtual	~Configurable ()
	Destroys a Configurable object.

	Configurable (const Configurable &other)
	Copies a Configurable object. More...

virtual Configurable &	operator= (const Configurable &other)
	Assignment operator for Configurable objects. 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	setConfiguration (ConfigurationDict &cfg)
	Sets the configuration dictionary for this object. 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	queryConfiguration ()
	Tells the object to create its configuration dictionary. 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. More...

virtual void	updateConfigurationDict ()
	Updates the configuration dictionary from object settings. 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

Base configurable object class.

Definition at line 79 of file Configurable.h.

Constructor & Destructor Documentation

◆ Configurable() [1/2]

Configurable	(	const std::string &	name = `"<unknown>"`,
		bool	debug = `false`
	)

Constructs a Configurable object.

Parameters

name	The name of this configurable object.
debug	Whether or not this object supports debug output methods.

Definition at line 57 of file Configurable.cpp.

◆ Configurable() [2/2]

Configurable ( const Configurable & other )

Copies a Configurable object.

Parameters

other The Configurable object to copy.

Definition at line 67 of file Configurable.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.

◆ getConfiguration()

ConfigurationDict getConfiguration ( ) const

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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.

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

◆ getName()

std::string getName ( ) const

virtual

Gets the name of the configurable object.

Returns: The name, as a string.

Definition at line 83 of file Configurable.cpp.

◆ initConfigurationDict()

void initConfigurationDict ( )

protectedvirtual

Initializes the configuration dictionary, defining the allowed keys.

Derived classes should use this method to define which settings are configurable through a configuration dictionary.

Note: Derived classes must also call this method explicitly in order to initialize their configuration dictionary.

Reimplemented in RadioHandler, TransmitterComponent, DucComponent, CWToneGenComponent, WbddcComponent, NbddcComponent, DataPort, RadioHandler, RadioHandler, RadioHandler, TunerComponent, RadioHandler, SimpleIpSetup, NbddcGroupComponent, WbddcGroupComponent, RadioComponent, NbddcComponent, WbddcComponent, WbddcComponent, TunerComponent, TunerComponent, TunerComponent, and DataPort.

Definition at line 221 of file Configurable.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.

◆ normalizedBool()

std::string normalizedBool ( const std::string & val )

protectedvirtual

Normalizes a Boolean string value.

Returns: The "normalized" string value.

Definition at line 241 of file Configurable.cpp.

◆ normalizedConfigurationDict()

ConfigurationDict normalizedConfigurationDict ( const ConfigurationDict & cfg )

protectedvirtual

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

Configurable & operator= ( const Configurable & other )

virtual

Assignment operator for Configurable objects.

Parameters

other The Configurable object to copy.

Returns: A reference to the assigned object.

Definition at line 73 of file Configurable.cpp.

◆ queryConfiguration()

void queryConfiguration ( )

virtual

Tells the object to create its configuration dictionary.

Derived classes should override this so that they issue hardware commands to determine initial configuration.

Reimplemented in RadioHandler, RadioHandler, RadioHandler, RadioHandler, RadioHandler, RadioHandler, RadioHandler, RadioHandler, CWToneGenComponent, WbddcComponent, NbddcComponent, DucComponent, RadioHandler, NbddcComponent, RadioComponent, TransmitterComponent, TunerComponent, WbddcComponent, WbddcComponent, NbddcGroupComponent, WbddcGroupComponent, DataPort, SimpleIpSetup, TunerComponent, TunerComponent, TunerComponent, and DataPort.

Definition at line 217 of file Configurable.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 )

virtual

Sets the configuration dictionary for this object.

This method is intended to allow users to change the object's settings based on the configuration dictionary. It should not be used to set configuration dictionary elements that the object does not use.

Parameters

cfg	The configuration dictionary.

Returns: True if successful, false otherwise.

Reimplemented in RadioHandler, CWToneGenComponent, WbddcComponent, NbddcComponent, DucComponent, RadioComponent, WbddcComponent, WbddcComponent, TransmitterComponent, TunerComponent, NbddcGroupComponent, WbddcGroupComponent, DataPort, TunerComponent, TunerComponent, and SimpleIpSetup.

Definition at line 161 of file Configurable.cpp.

◆ setConfigurationValue()

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

virtual

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
	)

virtual

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
	)

virtual

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
	)

virtual

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
	)

virtual

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.

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

◆ setName()

void setName ( const std::string & name )

virtual

Sets the name of the configurable object.

Parameters

name	The new name.

Definition at line 88 of file Configurable.cpp.

◆ updateConfigurationDict()

void updateConfigurationDict ( )

protectedvirtual

Updates the configuration dictionary from object settings.

Derived classes should use this method to convert the object's configurable settings into a configuration dictionary.

Reimplemented in RadioHandler, TransmitterComponent, DucComponent, CWToneGenComponent, WbddcComponent, NbddcComponent, DataPort, TunerComponent, SimpleIpSetup, NbddcComponent, NbddcGroupComponent, WbddcGroupComponent, WbddcComponent, WbddcComponent, RadioComponent, TunerComponent, TunerComponent, and TunerComponent.

Definition at line 225 of file Configurable.cpp.

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Configurable() [1/2]

◆ Configurable() [2/2]

Member Function Documentation

◆ debug()

◆ debugBool()

◆ getConfiguration()

◆ getConfigurationValue()

◆ getConfigurationValueAsBool()

◆ getConfigurationValueAsDbl()

◆ getConfigurationValueAsInt()

◆ getConfigurationValueAsUInt()

◆ getDebugName()

◆ getName()

◆ initConfigurationDict()

◆ isDebug()

◆ normalizedBool()

◆ normalizedConfigurationDict()

◆ operator=()

◆ queryConfiguration()

◆ rawString()

◆ setConfiguration()

◆ setConfigurationValue()

◆ setConfigurationValueToBool()

◆ setConfigurationValueToDbl()

◆ setConfigurationValueToInt()

◆ setConfigurationValueToUInt()

◆ setDebugFile()

◆ setDebugName()

◆ setDebugTimeFormat()

◆ setName()

◆ updateConfigurationDict()