libsigrokcxx  unreleased development snapshot
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

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

Detailed Description

An option used by an output format.

Definition at line 953 of file libsigrokcxx.hpp.

Member Function Documentation

std::string sigrok::Option::id ( ) const

Short name of this option suitable for command line usage.

std::string sigrok::Option::name ( ) const

Short name of this option suitable for GUI usage.

std::string sigrok::Option::description ( ) const

Description of this option in a sentence.

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

Default value for this option.

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

Possible values for this option, if a limited set.

Glib::VariantBase sigrok::Option::parse_string ( std::string  value)

Parse a string argument into the appropriate type for this option.


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