SoapySDR Namespace Reference

Classes
class	Device
class	Registry
class	Range

Typedefs
typedef SoapySDRLogLevel	LogLevel
typedef SoapySDRLogHandler	LogHandler
typedef std::vector< Kwargs >(*	FindFunction )(const Kwargs &)
	typedef for a device enumeration function More...
typedef Device *(*	MakeFunction )(const Kwargs &)
	typedef for a device factory function More...
typedef std::map< std::string, FindFunction >	FindFunctions
	typedef for a dictionary of find functions More...
typedef std::map< std::string, MakeFunction >	MakeFunctions
	typedef for a dictionary of make functions More...
typedef std::map< std::string, std::string >	Kwargs
	Typedef for a dictionary of key-value string arguments. More...
typedef std::vector< Range >	RangeList

Functions
SOAPY_SDR_API void	log (const LogLevel logLevel, const std::string &message)
SOAPY_SDR_API void	vlogf (const SoapySDRLogLevel logLevel, const char *format, va_list argList)
static void	logf (const SoapySDRLogLevel logLevel, const char *format,...)
SOAPY_SDR_API void	registerLogHandler (const LogHandler &handler)
SOAPY_SDR_API std::string	getRootPath (void)
	Query the root installation path. More...
SOAPY_SDR_API std::vector < std::string >	listModules (void)
SOAPY_SDR_API void	loadModule (const std::string &path)
SOAPY_SDR_API void	loadModules (void)
SOAPY_SDR_API std::string	getAPIVersion (void)
	Query the API version string. More...
SOAPY_SDR_API std::string	getABIVersion (void)

Typedef Documentation

typedef std::vector<Kwargs>(* SoapySDR::FindFunction)(const Kwargs &)

typedef for a device enumeration function

typedef std::map<std::string, FindFunction> SoapySDR::FindFunctions

typedef for a dictionary of find functions

typedef std::map<std::string, std::string> SoapySDR::Kwargs

Typedef for a dictionary of key-value string arguments.

typedef SoapySDRLogHandler SoapySDR::LogHandler

Typedef for the registered log handler function.

typedef SoapySDRLogLevel SoapySDR::LogLevel

typedef Device*(* SoapySDR::MakeFunction)(const Kwargs &)

typedef for a device factory function

typedef std::map<std::string, MakeFunction> SoapySDR::MakeFunctions

typedef for a dictionary of make functions

typedef std::vector<Range> SoapySDR::RangeList

Typedef for a list of min/max range pairs. Overall minimum: rl.front().minimum(); Overall maximum: rl.back().maximum();

Function Documentation

SOAPY_SDR_API std::string SoapySDR::getABIVersion

(

void

)

Get the ABI version string. This is the SOAPY_SDR_ABI_VERSION that the library was built against.

SOAPY_SDR_API std::string SoapySDR::getAPIVersion

(

void

)

Query the API version string.

SOAPY_SDR_API std::string SoapySDR::getRootPath

(

void

)

Query the root installation path.

SOAPY_SDR_API std::vector<std::string> SoapySDR::listModules

(

void

)

List the paths to the modules available on this system.

SOAPY_SDR_API void SoapySDR::loadModule

(

const std::string &

path

)

Load a single module given its file system path.

SOAPY_SDR_API void SoapySDR::loadModules

(

void

)

Load the support modules installed on this system. This call will only actually perform the load once. Subsequent calls are a NOP.

SOAPY_SDR_API void SoapySDR::log	(	const LogLevel	logLevel,
		const std::string &	message
	)

Send a message to the registered logger.

Parameters

logLevel	a possible logging level
message	a logger message string

static void SoapySDR::logf ( const SoapySDRLogLevel  logLevel, const char *  format,   ...  )

inlinestatic

Send a message to the registered logger.

Parameters

logLevel	a possible logging level
format	a printf style format string

SOAPY_SDR_API void SoapySDR::registerLogHandler

(

const LogHandler &

handler

)

Register a new system log handler. Platforms should call this to replace the default stdio handler.

SOAPY_SDR_API void SoapySDR::vlogf	(	const SoapySDRLogLevel	logLevel,
		const char *	format,
		va_list	argList
	)

Send a message to the registered logger.

Parameters

logLevel	a possible logging level
format	a printf style format string
argList	an argument list for the formatter