libsigrokdecode  0.5.3
sigrok protocol decoding library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules 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 * inputs
 List of possible decoder input IDs. More...
 
GSList * outputs
 List of possible decoder output IDs. More...
 
GSList * channels
 List of channels required by this decoder. More...
 
GSList * opt_channels
 List of optional channels for this decoder. More...
 
GSList * annotations
 List of annotation classes. More...
 
GSList * annotation_rows
 List of annotation rows (row items: id, description, and a list of annotation classes belonging to this row). More...
 
GSList * binary
 List of binary classes. More...
 
GSList * options
 List of decoder options. More...
 
void * py_mod
 Python module. More...
 
void * py_dec
 sigrokdecode.Decoder class. More...
 

Detailed Description

Definition at line 139 of file libsigrokdecode.h.

Field Documentation

GSList* srd_decoder::annotation_rows

List of annotation rows (row items: id, description, and a list of annotation classes belonging to this row).

Definition at line 180 of file libsigrokdecode.h.

GSList* srd_decoder::annotations

List of annotation classes.

Each list item is a GSList itself, with two NUL-terminated strings: name and description.

Definition at line 174 of file libsigrokdecode.h.

GSList* srd_decoder::binary

List of binary classes.

Each list item is a GSList itself, with two NUL-terminated strings: name and description.

Definition at line 186 of file libsigrokdecode.h.

GSList* srd_decoder::channels

List of channels required by this decoder.

Definition at line 165 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), srd_inst_channel_set_all(), and srd_inst_new().

char* srd_decoder::desc

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

Must be non-NULL.

Definition at line 150 of file libsigrokdecode.h.

Referenced by srd_decoder_load().

char* srd_decoder::id

The decoder ID.

Must be non-NULL and unique for all decoders.

Definition at line 141 of file libsigrokdecode.h.

Referenced by srd_decoder_get_by_id(), and srd_decoder_load().

GSList* srd_decoder::inputs

List of possible decoder input IDs.

Definition at line 159 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), and srd_inst_stack().

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 156 of file libsigrokdecode.h.

Referenced by srd_decoder_load().

char* srd_decoder::longname

The (long) decoder name.

Must be non-NULL.

Definition at line 147 of file libsigrokdecode.h.

Referenced by srd_decoder_load().

char* srd_decoder::name

The (short) decoder name.

Must be non-NULL.

Definition at line 144 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), and srd_inst_channel_set_all().

GSList* srd_decoder::opt_channels

List of optional channels for this decoder.

Definition at line 168 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), srd_inst_channel_set_all(), and srd_inst_new().

GSList* srd_decoder::options

List of decoder options.

Definition at line 189 of file libsigrokdecode.h.

Referenced by srd_inst_option_set().

GSList* srd_decoder::outputs

List of possible decoder output IDs.

Definition at line 162 of file libsigrokdecode.h.

Referenced by srd_decoder_load(), and srd_inst_stack().

void* srd_decoder::py_dec

sigrokdecode.Decoder class.

Definition at line 195 of file libsigrokdecode.h.

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

void* srd_decoder::py_mod

Python module.

Definition at line 192 of file libsigrokdecode.h.

Referenced by srd_decoder_doc_get(), and srd_decoder_load().


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