SoapySDR  0.4.4-gdb459f4f
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;
25 
27 typedef struct
28 {
29  size_t size;
30  char **keys;
31  char **vals;
33 
35 typedef enum
36 {
42 
44 typedef struct
45 {
47  char *key;
48 
54  char *value;
55 
57  char *name;
58 
60  char *description;
61 
63  char *units;
64 
66  SoapySDRArgInfoType type;
67 
74 
76  size_t numOptions;
77 
82  char **options;
83 
88  char **optionNames;
89 
91 
96 SOAPY_SDR_API void SoapySDRStrings_clear(char ***elems, const size_t length);
97 
101 SOAPY_SDR_API void SoapySDRKwargs_set(SoapySDRKwargs *args, const char *key, const char *val);
102 
107 SOAPY_SDR_API const char *SoapySDRKwargs_get(SoapySDRKwargs *args, const char *key);
108 
114 
119 SOAPY_SDR_API void SoapySDRKwargsList_clear(SoapySDRKwargs *args, const size_t length);
120 
126 
131 SOAPY_SDR_API void SoapySDRArgInfoList_clear(SoapySDRArgInfo *info, const size_t length);
132 
133 #ifdef __cplusplus
134 }
135 #endif
char * description
A brief description about the argument (optional)
Definition: Types.h:60
char * key
The key used to identify the argument (required)
Definition: Types.h:47
SOAPY_SDR_API void SoapySDRKwargsList_clear(SoapySDRKwargs *args, const size_t length)
size_t size
Definition: Types.h:29
SOAPY_SDR_API void SoapySDRKwargs_set(SoapySDRKwargs *args, const char *key, const char *val)
char ** optionNames
Definition: Types.h:88
SoapySDRArgInfoType
Possible data types for argument info.
Definition: Types.h:35
char ** options
Definition: Types.h:82
double minimum
Definition: Types.h:22
Definition for a key/value string map.
Definition: Types.h:27
Definition: Types.h:40
Definition: Types.h:39
Definition: Types.h:37
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:57
Definition: Types.h:38
size_t numOptions
The size of the options set, or 0 when not used.
Definition: Types.h:76
SoapySDRRange range
Definition: Types.h:73
Definition for argument info.
Definition: Types.h:44
Definition for a min/max numeric range.
Definition: Types.h:20
SOAPY_SDR_API void SoapySDRArgInfoList_clear(SoapySDRArgInfo *info, const size_t length)
SOAPY_SDR_API const char * SoapySDRKwargs_get(SoapySDRKwargs *args, const char *key)
#define SOAPY_SDR_API
Definition: Config.h:41
char ** vals
Definition: Types.h:31
char * value
Definition: Types.h:54
char ** keys
Definition: Types.h:30
SoapySDRArgInfoType type
The data type of the argument (required)
Definition: Types.h:66
char * units
The units of the argument: dB, Hz, etc (optional)
Definition: Types.h:63
SOAPY_SDR_API void SoapySDRStrings_clear(char ***elems, const size_t length)
SOAPY_SDR_API void SoapySDRKwargs_clear(SoapySDRKwargs *args)