![]() |
SoapySDR 0.8.1-gfbf9f3c3
Vendor and platform neutral SDR interface library
|
Definition for argument info. More...
#include <Types.h>
Public Attributes | |
char * | key |
The key used to identify the argument (required) | |
char * | value |
char * | name |
The displayable name of the argument (optional, use key if empty) | |
char * | description |
A brief description about the argument (optional) | |
char * | units |
The units of the argument: dB, Hz, etc (optional) | |
SoapySDRArgInfoType | type |
The data type of the argument (required) | |
SoapySDRRange | range |
size_t | numOptions |
The size of the options and optionNames sets, or 0 when not used. | |
char ** | options |
char ** | optionNames |
Definition for argument info.
char* SoapySDRArgInfo::description |
A brief description about the argument (optional)
char* SoapySDRArgInfo::key |
The key used to identify the argument (required)
char* SoapySDRArgInfo::name |
The displayable name of the argument (optional, use key if empty)
size_t SoapySDRArgInfo::numOptions |
The size of the options and optionNames sets, or 0 when not used.
char** SoapySDRArgInfo::optionNames |
A discrete list of displayable names for the enumerated options (optional) When not specified, the respective entry in this list will be NULL, and the option key itself can be used as a display name instead.
char** SoapySDRArgInfo::options |
A discrete list of possible values (optional) When specified, the argument should be restricted to this options set.
SoapySDRRange SoapySDRArgInfo::range |
The range of possible numeric values (optional) When specified, the argument should be restricted to this range. The range is only applicable to numeric argument types.
SoapySDRArgInfoType SoapySDRArgInfo::type |
The data type of the argument (required)
char* SoapySDRArgInfo::units |
The units of the argument: dB, Hz, etc (optional)
char* SoapySDRArgInfo::value |
The default value of the argument when not specified (required) Numbers should use standard floating point and integer formats. Boolean values should be represented as "true" and "false".