Base DUC component class. More...

#include <DucComponent.h>

Inheritance diagram for DucComponent:

Public Member Functions
	DucComponent (const std::string &name="DUC", int index=1, RadioHandler *parent=NULL, bool debug=false, double freqRangeMin=0.0, double freqRangeMax=0.0, double freqRes=1.0, double freqUnits=1.0, double attRangeMin=0.0, double attRangeMax=10.0, double attRes=1.0, int dataPort=0, double frequency=0.0, double attenuation=0.0, int rateIndex=0, int txChannels=0, int mode=0, unsigned int streamId=0)
	Constructs a DucComponent object. More...

virtual	~DucComponent ()
	Destroys a DucComponent object.

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

virtual DucComponent &	operator= (const DucComponent &other)
	Assignment operator for DucComponent 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 int	getDataPort () const
	Gets the DUC's data port. More...

virtual bool	setDataPort (int port)
	Sets the DUC's data port. More...

virtual double	getFrequency () const
	Gets the tuned frequency. More...

virtual bool	setFrequency (double freq)
	Sets the DUC 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 double	getAttenuation () const
	Gets the attenuation. More...

virtual bool	setAttenuation (double atten)
	Sets the attenuation. More...

virtual BasicDoubleList	getAttenuationRange () const
	Gets the attenuation range. More...

virtual double	getAttenuationRes () const
	Gets the attenuation resolution. More...

virtual int	getRateIndex () const
	Gets the DUC's rate index. More...

virtual bool	setRateIndex (int index)
	Sets the DUC's rate index. More...

virtual int	getTxChannelBitmap () const
	Gets the DUC's transmit channel bitmap. More...

virtual bool	setTxChannelBitmap (int txChannels)
	Sets the DUC's transmit channel bitmap. More...

virtual int	getMode () const
	Gets the DUC's mode. More...

virtual bool	setMode (int mode)
	Sets the DUC's mode. More...

virtual unsigned int	getStreamId () const
	Gets the DUC's VITA 49 stream ID. More...

virtual bool	setStreamId (unsigned int sid)
	Sets the DUC's VITA 49 stream ID. More...

virtual DucRateSet	getRateSet () const
	Gets the DUC's rate set. More...

virtual bool	setRateSet (const DucRateSet &set)
	Sets the DUC rate set. More...

virtual BasicDoubleList	getRateList () const
	Gets the list of allowed sample rates, based on the rate set. More...

virtual bool	supportsSnapshotLoad () const
	Gets whether or not the DUC supports loading snapshot files. More...

virtual bool	loadSnapshot (const std::string &filename, unsigned int startSample=0, unsigned int samples=0)
	Load a snapshot file into the DUC's memory block. More...

virtual bool	supportsSnapshotTransmit () const
	Gets whether or not the DUC supports transmitting snapshots. 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	executeDucQuery (int index, int &dataPort, double &frequency, double &attenuation, int &rateIndex, int &txChannels, int &mode, unsigned int &streamId)
	Executes the DUC configuration query command. More...

virtual bool	executeDucCommand (int index, int &dataPort, double &frequency, double &attenuation, int &rateIndex, int &txChannels, int &mode, unsigned int &streamId)
	Executes the DUC configuration set command. More...

virtual bool	executeSnapshotLoadCommand (int index, const std::string &filename, unsigned int startSample, unsigned int samples)
	Executes the DUC snapshot load 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

Base DUC component class.

A radio handler object maintains one DUC component object per DUC on the radio.

Configuration dictionary elements:

"enable": Whether or not this DUC is enabled [Boolean/integer/string]
"dataPort": Data port index [integer/string]
"frequency": Tuned frequency (Hz) [double/string]
"attenuation": Attenuation (dB) [double/string]
"rateIndex": Rate index [integer/string]
"txChannels": Transmit channel bitmap [integer/string]
"mode": DUC mode [integer/string]
"streamId": VITA stream ID [integer/string]
"filename": Snapshot file name [string]
"startSample": Start sample number [integer/string]
"samples": Number of samples [integer/string]
"singlePlayback": Whether or not to do a single playback [Boolean/integer/string]
"pauseUntilEnabled": Whether or not to pause snapshot until enabled [Boolean/integer/string]

Note: Support for these elements varies by radio. See the documentation for the particular radio's DUC specialization to determine what elements are supported.

Definition at line 65 of file DucComponent.h.

Constructor & Destructor Documentation

◆ DucComponent() [1/2]

DucComponent	(	const std::string &	name = `"DUC"`,
		int	index = `1`,
		RadioHandler *	parent = `NULL`,
		bool	debug = `false`,
		double	freqRangeMin = `0.0`,
		double	freqRangeMax = `0.0`,
		double	freqRes = `1.0`,
		double	freqUnits = `1.0`,
		double	attRangeMin = `0.0`,
		double	attRangeMax = `10.0`,
		double	attRes = `1.0`,
		int	dataPort = `0`,
		double	frequency = `0.0`,
		double	attenuation = `0.0`,
		int	rateIndex = `0`,
		int	txChannels = `0`,
		int	mode = `0`,
		unsigned int	streamId = `0`
	)

Constructs a DucComponent object.

Parameters

name	The name of this component.
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.
freqRangeMin	Minimum tunable frequency (Hz).
freqRangeMax	Maximum tunable frequency (Hz).
freqRes	Tunable frequency resolution (Hz).
freqUnits	Tunable frequency units (Hz).
attRangeMin	Minimum attenuation (dB).
attRangeMax	Maximum attenuation (dB).
attRes	Attenuation resolution (dB).
dataPort	Data port used by this DUC. Setting this to 0 stops streaming.
frequency	Tuned frequency (Hz).
attenuation	Attenuation (dB).
rateIndex	DUC rate index. This should be one of the rate indices in the DUC's rate set.
txChannels	Bitmap indicating which transmitters output the signal from this DUC. Setting a bit position to 1 enables transmit on the associated transmitter. The LSB corresponds to TX 1, and each succeeding bit corresponds to the other transmitters.
mode	DUC mode. Either 0 (streaming mode) or 1 (playback mode).
streamId	VITA 49 stream ID.

Definition at line 24 of file DucComponent.cpp.

◆ DucComponent() [2/2]

DucComponent ( const DucComponent & other )

Copies a DucComponent object.

Parameters

other The DucComponent object to copy.

Definition at line 74 of file DucComponent.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 )

virtual

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 130 of file DucComponent.cpp.

◆ executeDucCommand()

bool executeDucCommand	(	int	index,
		int &	dataPort,
		double &	frequency,
		double &	attenuation,
		int &	rateIndex,
		int &	txChannels,
		int &	mode,
		unsigned int &	streamId
	)

protectedvirtual

Executes the DUC configuration set command.

Parameters

index	DUC index.
dataPort	Data port number (0 disables).
frequency	Tuned frequency (Hz).
attenuation	Attenuation (dB).
rateIndex	DUC's rate index.
txChannels	DUC's TX channel output bitmap.
mode	DUC's mode setting.
streamId	DUC's VITA 49 stream ID.

Returns: True if the command succeeded, false otherwise.

Definition at line 622 of file DucComponent.cpp.

◆ executeDucQuery()

bool executeDucQuery	(	int	index,
		int &	dataPort,
		double &	frequency,
		double &	attenuation,
		int &	rateIndex,
		int &	txChannels,
		int &	mode,
		unsigned int &	streamId
	)

protectedvirtual

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

index	DUC index.
dataPort	Data port number (0 disables) (return).
frequency	Tuned frequency (Hz) (return).
attenuation	Attenuation (dB) (return).
rateIndex	DUC's rate index (return).
txChannels	DUC's TX channel output bitmap (return).
mode	DUC's mode setting (return).
streamId	DUC's VITA 49 stream ID (return).

Returns: True if the command succeeded, false otherwise.

Definition at line 581 of file DucComponent.cpp.

◆ executeSnapshotLoadCommand()

bool executeSnapshotLoadCommand	(	int	index,
		const std::string &	filename,
		unsigned int	startSample,
		unsigned int	samples
	)

protectedvirtual

Executes the DUC snapshot load command.

Parameters

index	DUC index.
filename	Snapshot file name.
startSample	Starting sample number.
samples	Number of samples (0 = load maximum).

Returns: True if the command succeeded, false otherwise.

Definition at line 653 of file DucComponent.cpp.

◆ getAttenuation()

double getAttenuation ( ) const

virtual

Gets the attenuation.

Returns: The attenuation, in dB.

Definition at line 328 of file DucComponent.cpp.

◆ getAttenuationRange()

BasicDoubleList getAttenuationRange ( ) const

virtual

Gets the attenuation range.

Returns: A list containing the minimum and maximum attenuation values.

Definition at line 356 of file DucComponent.cpp.

◆ getAttenuationRes()

double getAttenuationRes ( ) const

virtual

Gets the attenuation resolution.

Returns: The resolution.

Definition at line 364 of file DucComponent.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

virtual

Gets the DUC's data port.

Returns: The data port.

Definition at line 254 of file DucComponent.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

virtual

Gets the tuned frequency.

Returns: The tuned frequency, in Hz.

Definition at line 282 of file DucComponent.cpp.

◆ getFrequencyRange()

BasicDoubleList getFrequencyRange ( ) const

virtual

Gets the tunable frequency range.

Returns: A list containing the minimum and maximum frequencies.

Definition at line 310 of file DucComponent.cpp.

◆ getFrequencyRes()

double getFrequencyRes ( ) const

virtual

Gets the tuned frequency resolution.

Returns: The frequency resolution, in Hz.

Definition at line 318 of file DucComponent.cpp.

◆ getFrequencyUnit()

double getFrequencyUnit ( ) const

virtual

Gets the tuned frequency units.

Returns: The frequency units, in Hz.

Definition at line 323 of file DucComponent.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.

◆ getMode()

int getMode ( ) const

virtual

Gets the DUC's mode.

Returns: The mode. This is either 0 (streaming) or 1 (playback).

Definition at line 425 of file DucComponent.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

virtual

Gets the DUC's rate index.

Returns: The rate index.

Definition at line 369 of file DucComponent.cpp.

◆ getRateList()

BasicDoubleList getRateList ( ) const

virtual

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

Returns: The rate list.

Definition at line 492 of file DucComponent.cpp.

◆ getRateSet()

DucRateSet getRateSet ( ) const

virtual

Gets the DUC's rate set.

Returns: The rate set.

Definition at line 481 of file DucComponent.cpp.

◆ getStreamId()

unsigned int getStreamId ( ) const

virtual

Gets the DUC's VITA 49 stream ID.

Returns: The VITA 49 stream ID.

Definition at line 453 of file DucComponent.cpp.

◆ getTxChannelBitmap()

int getTxChannelBitmap ( ) const

virtual

Gets the DUC's transmit channel bitmap.

Returns: Bitmap indicating which transmitters are outputting the signal from this DUC. If a bit position is 1, the associated transmitter is active. The LSB corresponds to TX 1, and each succeeding bit corresponds to the other transmitters.

Definition at line 397 of file DucComponent.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.

◆ loadSnapshot()

bool loadSnapshot	(	const std::string &	filename,
		unsigned int	startSample = `0`,
		unsigned int	samples = `0`
	)

virtual

Load a snapshot file into the DUC's memory block.

Snapshot files contain 16-bit complex I/Q data samples.

Parameters

filename	Snapshot file name. The snapshot file needs to be present on the radio.
startSample	Starting address in DUC's memory block. Must be a multiple of 1024.
samples	Number of I/Q samples to load. Must be a multiple of 16. If specified as 0, load the maximum number of samples from the file.

Returns: True if successful, false otherwise.

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

DucComponent & operator= ( const DucComponent & other )

virtual

Assignment operator for DucComponent objects.

Parameters

other The DucComponent object to copy.

Returns: A reference to the assigned object.

Definition at line 100 of file DucComponent.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.

◆ setAttenuation()

bool setAttenuation ( double atten )

virtual

Sets the attenuation.

Parameters

atten The new attenuation (dB).

Returns: True if successful, false otherwise.

Definition at line 333 of file DucComponent.cpp.

◆ setConfiguration()

bool setConfiguration ( ConfigurationDict & cfg )

virtual

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 135 of file DucComponent.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 )

virtual

Sets the DUC's data port.

Parameters

port	The new data port. Setting this to 0 disables streaming.

Returns: True if successful, false otherwise.

Definition at line 259 of file DucComponent.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 )

virtual

Sets the DUC tuned frequency.

Parameters

freq	The new tuned frequency (Hz).

Returns: True if successful, false otherwise.

Definition at line 287 of file DucComponent.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.

◆ setMode()

bool setMode ( int mode )

virtual

Sets the DUC's mode.

Parameters

mode	The new mode. This is either 0 (streaming) or 1 (playback).

Returns: True if successful, false otherwise.

Definition at line 430 of file DucComponent.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 )

virtual

Sets the DUC's rate index.

Parameters

index The new rate index.

Returns: True if successful, false otherwise.

Definition at line 374 of file DucComponent.cpp.

◆ setRateSet()

bool setRateSet ( const DucRateSet & set )

virtual

Sets the DUC rate set.

Parameters

set	The new rate set.

Returns: True if successful, false otherwise.

Definition at line 486 of file DucComponent.cpp.

◆ setStreamId()

bool setStreamId ( unsigned int sid )

virtual

Sets the DUC's VITA 49 stream ID.

Parameters

sid	The new stream ID.

Returns: True if successful, false otherwise.

Definition at line 458 of file DucComponent.cpp.

◆ setTxChannelBitmap()

bool setTxChannelBitmap ( int txChannels )

virtual

Sets the DUC's transmit channel bitmap.

Parameters

txChannels Bitmap indicating which transmitters output the signal from this DUC. Setting a bit position to 1 enables transmit on the associated transmitter. The LSB corresponds to TX 1, and each succeeding bit corresponds to the other transmitters.

Returns: True if successful, false otherwise.

Definition at line 402 of file DucComponent.cpp.

◆ supportsSnapshotLoad()

bool supportsSnapshotLoad ( ) const

virtual

Gets whether or not the DUC supports loading snapshot files.

Returns: True if supported, false otherwise.

Definition at line 502 of file DucComponent.cpp.

◆ supportsSnapshotTransmit()

bool supportsSnapshotTransmit ( ) const

virtual

Gets whether or not the DUC supports transmitting snapshots.

Returns: True if supported, false otherwise.

Definition at line 523 of file DucComponent.cpp.

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DucComponent() [1/2]

◆ DucComponent() [2/2]

Member Function Documentation

◆ debug()

◆ debugBool()

◆ disable()

◆ enable()

◆ executeDucCommand()

◆ executeDucQuery()

◆ executeSnapshotLoadCommand()

◆ getAttenuation()

◆ getAttenuationRange()

◆ getAttenuationRes()

◆ getConfiguration()

◆ getConfigurationValue()

◆ getConfigurationValueAsBool()

◆ getConfigurationValueAsDbl()

◆ getConfigurationValueAsInt()

◆ getConfigurationValueAsUInt()

◆ getDataPort()

◆ getDebugName()

◆ getFrequency()

◆ getFrequencyRange()

◆ getFrequencyRes()

◆ getFrequencyUnit()

◆ getIndex()

◆ getMode()

◆ getName()

◆ getParent()

◆ getRateIndex()

◆ getRateList()

◆ getRateSet()

◆ getStreamId()

◆ getTxChannelBitmap()

◆ isDebug()

◆ isEnabled()

◆ loadSnapshot()

◆ normalizedBool()

◆ normalizedConfigurationDict()

◆ operator=()

◆ rawString()

◆ setAttenuation()

◆ setConfiguration()

◆ setConfigurationValue()

◆ setConfigurationValueToBool()

◆ setConfigurationValueToDbl()

◆ setConfigurationValueToInt()

◆ setConfigurationValueToUInt()

◆ setDataPort()

◆ setDebugFile()

◆ setDebugName()

◆ setDebugTimeFormat()

◆ setFrequency()

◆ setIndex()

◆ setMode()

◆ setName()

◆ setParent()

◆ setRateIndex()

◆ setRateSet()

◆ setStreamId()

◆ setTxChannelBitmap()

◆ supportsSnapshotLoad()

◆ supportsSnapshotTransmit()