SoapySDR  0.7.1-g5838bc91
Vendor and platform neutral SDR interface library
Types.h
Go to the documentation of this file.
1 
11 #pragma once
12 #include <SoapySDR/Config.h>
13 #include <stddef.h> //size_t
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
20 typedef struct
21 {
22  double minimum;
23  double maximum;
24  double step;
26 
28 typedef struct
29 {
30  size_t size;
31  char **keys;
32  char **vals;
34 
40 
46 
48 typedef enum
49 {
55 
57 typedef struct
58 {
60  char *key;
61 
67  char *value;
68 
70  char *name;
71 
73  char *description;
74 
76  char *units;
77 
79  SoapySDRArgInfoType type;
80 
87 
89  size_t numOptions;
90 
95  char **options;
96 
101  char **optionNames;
102 
104 
109 SOAPY_SDR_API void SoapySDRStrings_clear(char ***elems, const size_t length);
110 
120 SOAPY_SDR_API int SoapySDRKwargs_set(SoapySDRKwargs *args, const char *key, const char *val);
121 
126 SOAPY_SDR_API const char *SoapySDRKwargs_get(const SoapySDRKwargs *args, const char *key);
127 
133 
138 SOAPY_SDR_API void SoapySDRKwargsList_clear(SoapySDRKwargs *args, const size_t length);
139 
145 
150 SOAPY_SDR_API void SoapySDRArgInfoList_clear(SoapySDRArgInfo *info, const size_t length);
151 
152 #ifdef __cplusplus
153 }
154 #endif
char * description
A brief description about the argument (optional)
Definition: Types.h:73
char * key
The key used to identify the argument (required)
Definition: Types.h:60
SOAPY_SDR_API void SoapySDRKwargsList_clear(SoapySDRKwargs *args, const size_t length)
size_t size
Definition: Types.h:30
SOAPY_SDR_API char * SoapySDRKwargs_toString(const SoapySDRKwargs *args)
char ** optionNames
Definition: Types.h:101
SoapySDRArgInfoType
Possible data types for argument info.
Definition: Types.h:48
SOAPY_SDR_API const char * SoapySDRKwargs_get(const SoapySDRKwargs *args, const char *key)
char ** options
Definition: Types.h:95
double minimum
Definition: Types.h:22
Definition for a key/value string map.
Definition: Types.h:28
Definition: Types.h:53
Definition: Types.h:52
Definition: Types.h:50
SOAPY_SDR_API void SoapySDRArgInfo_clear(SoapySDRArgInfo *info)
double maximum
Definition: Types.h:23
char * name
The displayable name of the argument (optional, use key if empty)
Definition: Types.h:70
Definition: Types.h:51
size_t numOptions
The size of the options set, or 0 when not used.
Definition: Types.h:89
SoapySDRRange range
Definition: Types.h:86
Definition for argument info.
Definition: Types.h:57
double step
Definition: Types.h:24
Definition for a min/max numeric range.
Definition: Types.h:20
SOAPY_SDR_API void SoapySDRArgInfoList_clear(SoapySDRArgInfo *info, const size_t length)
#define SOAPY_SDR_API
Definition: Config.h:41
char ** vals
Definition: Types.h:32
char * value
Definition: Types.h:67
char ** keys
Definition: Types.h:31
SoapySDRArgInfoType type
The data type of the argument (required)
Definition: Types.h:79
SOAPY_SDR_API int SoapySDRKwargs_set(SoapySDRKwargs *args, const char *key, const char *val)
SOAPY_SDR_API SoapySDRKwargs SoapySDRKwargs_fromString(const char *markup)
char * units
The units of the argument: dB, Hz, etc (optional)
Definition: Types.h:76
SOAPY_SDR_API void SoapySDRStrings_clear(char ***elems, const size_t length)
SOAPY_SDR_API void SoapySDRKwargs_clear(SoapySDRKwargs *args)