SoapySDR  0.8.1-g640ac414
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 #define SOAPY_SDR_TRUE "true"
21 
23 #define SOAPY_SDR_FALSE "false"
24 
26 typedef struct
27 {
28  double minimum;
29  double maximum;
30  double step;
32 
34 typedef struct
35 {
36  size_t size;
37  char **keys;
38  char **vals;
40 
46 
52 
54 typedef enum
55 {
61 
63 typedef struct
64 {
66  char *key;
67 
73  char *value;
74 
76  char *name;
77 
79  char *description;
80 
82  char *units;
83 
86 
93 
95  size_t numOptions;
96 
101  char **options;
102 
108  char **optionNames;
109 
111 
116 SOAPY_SDR_API void SoapySDR_free(void *ptr);
117 
122 SOAPY_SDR_API void SoapySDRStrings_clear(char ***elems, const size_t length);
123 
133 SOAPY_SDR_API int SoapySDRKwargs_set(SoapySDRKwargs *args, const char *key, const char *val);
134 
139 SOAPY_SDR_API const char *SoapySDRKwargs_get(const SoapySDRKwargs *args, const char *key);
140 
146 
151 SOAPY_SDR_API void SoapySDRKwargsList_clear(SoapySDRKwargs *args, const size_t length);
152 
158 
163 SOAPY_SDR_API void SoapySDRArgInfoList_clear(SoapySDRArgInfo *info, const size_t length);
164 
165 #ifdef __cplusplus
166 }
167 #endif
#define SOAPY_SDR_API
Definition: Config.h:41
SOAPY_SDR_API void SoapySDR_free(void *ptr)
SOAPY_SDR_API void SoapySDRArgInfoList_clear(SoapySDRArgInfo *info, const size_t length)
SoapySDRArgInfoType
Possible data types for argument info.
Definition: Types.h:55
@ SOAPY_SDR_ARG_INFO_BOOL
Definition: Types.h:56
@ SOAPY_SDR_ARG_INFO_FLOAT
Definition: Types.h:58
@ SOAPY_SDR_ARG_INFO_INT
Definition: Types.h:57
@ SOAPY_SDR_ARG_INFO_STRING
Definition: Types.h:59
SOAPY_SDR_API void SoapySDRStrings_clear(char ***elems, const size_t length)
SOAPY_SDR_API const char * SoapySDRKwargs_get(const SoapySDRKwargs *args, const char *key)
SOAPY_SDR_API int SoapySDRKwargs_set(SoapySDRKwargs *args, const char *key, const char *val)
SOAPY_SDR_API char * SoapySDRKwargs_toString(const SoapySDRKwargs *args)
SOAPY_SDR_API void SoapySDRKwargs_clear(SoapySDRKwargs *args)
SOAPY_SDR_API void SoapySDRKwargsList_clear(SoapySDRKwargs *args, const size_t length)
SOAPY_SDR_API void SoapySDRArgInfo_clear(SoapySDRArgInfo *info)
SOAPY_SDR_API SoapySDRKwargs SoapySDRKwargs_fromString(const char *markup)
Definition for argument info.
Definition: Types.h:64
char * name
The displayable name of the argument (optional, use key if empty)
Definition: Types.h:76
SoapySDRArgInfoType type
The data type of the argument (required)
Definition: Types.h:85
size_t numOptions
The size of the options and optionNames sets, or 0 when not used.
Definition: Types.h:95
SoapySDRRange range
Definition: Types.h:92
char ** options
Definition: Types.h:101
char ** optionNames
Definition: Types.h:108
char * value
Definition: Types.h:73
char * units
The units of the argument: dB, Hz, etc (optional)
Definition: Types.h:82
char * key
The key used to identify the argument (required)
Definition: Types.h:66
char * description
A brief description about the argument (optional)
Definition: Types.h:79
Definition for a key/value string map.
Definition: Types.h:35
size_t size
Definition: Types.h:36
char ** vals
Definition: Types.h:38
char ** keys
Definition: Types.h:37
Definition for a min/max numeric range.
Definition: Types.h:27
double minimum
Definition: Types.h:28
double maximum
Definition: Types.h:29
double step
Definition: Types.h:30