libsigrokcxx  0.4.0
C++ bindings for libsigrok
Public Member Functions | List of all members
sigrok::Option Class Reference

An option used by an output format. More...

#include <libsigrokcxx/libsigrokcxx.hpp>

Inherits sigrok::UserOwned< Class >.

Public Member Functions

string id () const
 Short name of this option suitable for command line usage. More...
 
string name () const
 Short name of this option suitable for GUI usage. More...
 
string description () const
 Description of this option in a sentence. More...
 
Glib::VariantBase default_value () const
 Default value for this option. More...
 
vector< Glib::VariantBase > values () const
 Possible values for this option, if a limited set. More...
 

Detailed Description

An option used by an output format.

Definition at line 858 of file libsigrokcxx.hpp.

Member Function Documentation

string sigrok::Option::id ( ) const

Short name of this option suitable for command line usage.

string sigrok::Option::name ( ) const

Short name of this option suitable for GUI usage.

string sigrok::Option::description ( ) const

Description of this option in a sentence.

Glib::VariantBase sigrok::Option::default_value ( ) const

Default value for this option.

vector<Glib::VariantBase> sigrok::Option::values ( ) const

Possible values for this option, if a limited set.


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