libsigrokdecode  unreleased development snapshot
sigrok protocol decoding library
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 * tags
 List of tags associated with this decoder. 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 * logic_output_channels
 List of logic output channels (item: id, description). 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 144 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 188 of file libsigrokdecode.h.

Referenced by srd_decoder_get_by_id(), and srd_decoder_load().

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

Referenced by srd_decoder_get_by_id(), and srd_decoder_load().

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

Referenced by srd_decoder_get_by_id(), and srd_decoder_load().

GSList* srd_decoder::channels

List of channels required by this decoder.

Definition at line 173 of file libsigrokdecode.h.

Referenced by srd_decoder_get_by_id(), 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 155 of file libsigrokdecode.h.

Referenced by srd_decoder_get_by_id(), and srd_decoder_load().

char* srd_decoder::id

The decoder ID.

Must be non-NULL and unique for all decoders.

Definition at line 146 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 164 of file libsigrokdecode.h.

Referenced by srd_decoder_get_by_id(), 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 161 of file libsigrokdecode.h.

Referenced by srd_decoder_get_by_id(), and srd_decoder_load().

GSList* srd_decoder::logic_output_channels

List of logic output channels (item: id, description).

Definition at line 199 of file libsigrokdecode.h.

Referenced by srd_decoder_get_by_id().

char* srd_decoder::longname

The (long) decoder name.

Must be non-NULL.

Definition at line 152 of file libsigrokdecode.h.

Referenced by srd_decoder_get_by_id(), and srd_decoder_load().

char* srd_decoder::name

The (short) decoder name.

Must be non-NULL.

Definition at line 149 of file libsigrokdecode.h.

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

GSList* srd_decoder::opt_channels

List of optional channels for this decoder.

Definition at line 176 of file libsigrokdecode.h.

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

GSList* srd_decoder::options

List of decoder options.

Definition at line 202 of file libsigrokdecode.h.

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

GSList* srd_decoder::outputs

List of possible decoder output IDs.

Definition at line 167 of file libsigrokdecode.h.

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

void* srd_decoder::py_dec

sigrokdecode.Decoder class.

Definition at line 208 of file libsigrokdecode.h.

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

void* srd_decoder::py_mod

Python module.

Definition at line 205 of file libsigrokdecode.h.

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

GSList* srd_decoder::tags

List of tags associated with this decoder.

Definition at line 170 of file libsigrokdecode.h.

Referenced by srd_decoder_get_by_id(), and srd_decoder_load().


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