LibCyberRadio::Driver Namespace Reference

Provides programming elements for driving CRS NDR-class radios. More...

Namespaces
	NDR308
	Provides programming elements for driving NDR308 radios.
	NDR308TS
	Provides programming elements for driving NDR308-TS radios.
	NDR324
	Provides programming elements for driving NDR551 radios.
	NDR358
	Provides programming elements for driving NDR551 radios.
	NDR472
	Provides programming elements for driving NDR472 radios.
	NDR551
	Provides programming elements for driving NDR551 radios.
	NDR651
	Provides programming elements for driving NDR651 radios.
	NDR810
	Provides programming elements for driving NDR810 radios.

Data Structures
class	ConfigString
	Configuration value string class. More...
class	Configurable
	Base configurable object class. More...
class	ConfigurationDict
	A configuration dictionary. More...
class	CWToneGenComponent
	Base continuous-wave (CW) tone generator component class. More...
class	DataPort
	10GigE data port class. More...
class	DucComponent
	Base DUC component class. More...
class	NbddcComponent
	Base NBDDC component class. More...
class	NbddcGroupComponent
	Base NBDDC group component class. More...
class	RadioComponent
	Base hardware component class. More...
class	RadioHandler
	Generic radio handler class. More...
class	RadioTransport
	Generic radio transport class. More...
class	SimpleIpSetup
	Simple IP setup class for radios without 10GigE data ports. More...
class	TransmitterComponent
	Base transmitter component class. More...
class	TunerComponent
	Base tuner component class. More...
class	VitaIfSpec
	Class that defines the VITA interface specification for an NDR-class radio. More...
class	WbddcComponent
	Base WBDDC component class. More...
class	WbddcGroupComponent
	Base WBDDC group component class. More...

Typedefs
typedef BASIC_DICT_CONTAINER< int, CWToneGenComponent * >	CWToneGenComponentDict
	A dictionary of CW tone generator components, keyed by index.
typedef BASIC_DICT_CONTAINER< int, DataPort * >	DataPortDict
	A dictionary of data ports, keyed by index.
typedef std::shared_ptr< RadioHandler >	RadioHandlerPtr
	A pointer to a radio handler object.
typedef BASIC_DICT_CONTAINER< int, double >	DucRateSet
	A rate set for a DUC. More...
typedef BASIC_DICT_CONTAINER< int, DucComponent * >	DucComponentDict
	A dictionary of DUC components, keyed by index.
typedef BASIC_DICT_CONTAINER< int, double >	NbddcRateSet
	A rate set for a NBDDC. More...
typedef BASIC_DICT_CONTAINER< int, NbddcComponent * >	NbddcComponentDict
	A dictionary of NBDDC components, keyed by index.
typedef BASIC_DICT_CONTAINER< int, NbddcGroupComponent * >	NbddcGroupComponentDict
	A dictionary of NBDDC group components, keyed by index.
typedef BASIC_DICT_CONTAINER< int, SimpleIpSetup * >	SimpleIpSetupDict
	A dictionary of data ports, keyed by index.
typedef BASIC_DICT_CONTAINER< int, TransmitterComponent * >	TransmitterComponentDict
	A dictionary of tuner components, keyed by index.
typedef BASIC_DICT_CONTAINER< int, TunerComponent * >	TunerComponentDict
	A dictionary of tuner components, keyed by index.
typedef BASIC_DICT_CONTAINER< int, double >	WbddcRateSet
	A rate set for a WBDDC. More...
typedef BASIC_DICT_CONTAINER< int, WbddcComponent * >	WbddcComponentDict
	A dictionary of WBDDC components, keyed by index.
typedef BASIC_DICT_CONTAINER< int, WbddcGroupComponent * >	WbddcGroupComponentDict
	A dictionary of WBDDC group components, keyed by index.

Functions
RadioHandlerPtr	getRadioObject (const std::string &nameString, const std::string &device="", int devicePort=-1, bool debug=false)
	Factory method for returning a radio handler object for a given radio. More...

Detailed Description

Provides programming elements for driving CRS NDR-class radios.

Typedef Documentation

DucRateSet

typedef BASIC_DICT_CONTAINER<int, double> DucRateSet

A rate set for a DUC.

A rate set is a series of sample rates (in samples per second), keyed by rate index.

Definition at line 36 of file DucComponent.h.

NbddcRateSet

typedef BASIC_DICT_CONTAINER<int, double> NbddcRateSet

A rate set for a NBDDC.

A rate set is a series of sample rates (in samples per second), keyed by rate index.

Definition at line 36 of file NbddcComponent.h.

WbddcRateSet

typedef BASIC_DICT_CONTAINER<int, double> WbddcRateSet

A rate set for a WBDDC.

A rate set is a series of sample rates (in samples per second), keyed by rate index.

Definition at line 36 of file WbddcComponent.h.

Function Documentation

getRadioObject()

RadioHandlerPtr getRadioObject	(	const std::string &	nameString,
		const std::string &	device = "",
		int	devicePort = -1,
		bool	debug = false
	)

Factory method for returning a radio handler object for a given radio.

The pointer returned by this object refers to an object that supports the standard RadioHandler interface. However, certain radios may not support all features of this interface. Refer to the radio's specific documentation for details.

This method supports automatically connecting to the specified radio device. Setting device to the device name (network host name/IP address or serial device) – and devicePort if necessary – activates this functionality.

Parameters

nameString	A name string identifying the radio type.
device	Device name [string]. This is either a host name/ IP address (for network devices) or a serial device name (for USB-connected radios).
devicePort	Device port [integer]. This is either a port number (for network devices) or a serial baud rate (for USB-connected radios). Setting this to -1 means to use the default for the radio handler.
debug	Whether or not the radio handler creates debug output [Boolean].

Returns

A shared pointer referring to the radio handler object. Returns NULL if an appropriate radio handler cannot be determined.

Definition at line 34 of file Driver.cpp.