libsigrokdecode  0.2.0
sigrok protocol decoding library
 All Data Structures Files Functions Variables Typedefs Enumerator Macros Groups Pages
Data Fields
srd_decoder Struct Reference

#include <libsigrokdecode.h>

+ Collaboration diagram for srd_decoder:

Data Fields

char * id
 The decoder ID. More...
 
char * name
 The (short) decoder name. More...
 
char * longname
 The (long) decoder name. More...
 
char * desc
 A (short, one-line) description of the decoder. More...
 
char * license
 The license of the decoder. More...
 
GSList * probes
 List of probes required by this decoder. More...
 
GSList * opt_probes
 List of optional probes for this decoder. More...
 
GSList * annotations
 List of NULL-terminated char[], containing descriptions of the supported annotation output. More...
 
GSList * options
 List of decoder options. More...
 
PyObject * py_mod
 Python module. More...
 
PyObject * py_dec
 sigrokdecode.Decoder class. More...
 

Detailed Description

Definition at line 167 of file libsigrokdecode.h.

Field Documentation

GSList* srd_decoder::annotations

List of NULL-terminated char[], containing descriptions of the supported annotation output.

Definition at line 196 of file libsigrokdecode.h.

Referenced by srd_decoder_load().

char* srd_decoder::desc

A (short, one-line) description of the decoder.

Must be non-NULL.

Definition at line 178 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), and srd_decoder_unload().

char* srd_decoder::id

The decoder ID.

Must be non-NULL and unique for all decoders.

Definition at line 169 of file libsigrokdecode.h.

Referenced by srd_decoder_get_by_id(), srd_decoder_load(), and srd_decoder_unload().

char* srd_decoder::license

The license of the decoder.

Valid values: "gplv2+", "gplv3+". Other values are currently not allowed. Must be non-NULL.

Definition at line 184 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), and srd_decoder_unload().

char* srd_decoder::longname

The (long) decoder name.

Must be non-NULL.

Definition at line 175 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), and srd_decoder_unload().

char* srd_decoder::name

The (short) decoder name.

Must be non-NULL.

Definition at line 172 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), srd_decoder_unload(), and srd_inst_probe_set_all().

GSList* srd_decoder::opt_probes

List of optional probes for this decoder.

Definition at line 190 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), srd_decoder_unload(), srd_inst_new(), and srd_inst_probe_set_all().

GSList* srd_decoder::options

List of decoder options.

Definition at line 199 of file libsigrokdecode.h.

Referenced by srd_decoder_unload().

GSList* srd_decoder::probes

List of probes required by this decoder.

Definition at line 187 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), srd_decoder_unload(), srd_inst_new(), and srd_inst_probe_set_all().

PyObject* srd_decoder::py_dec

sigrokdecode.Decoder class.

Definition at line 205 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), srd_decoder_unload(), srd_inst_new(), and srd_inst_option_set().

PyObject* srd_decoder::py_mod

Python module.

Definition at line 202 of file libsigrokdecode.h.

Referenced by srd_decoder_doc_get(), srd_decoder_load(), and srd_decoder_unload().


The documentation for this struct was generated from the following file: