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

An input format supported by the library. More...

#include <libsigrokcxx/libsigrokcxx.hpp>

Inherits sigrok::ParentOwned< Class, Parent >.

Public Member Functions

string name () const
 Name of this input format. More...
 
string description () const
 Description of this input format. More...
 
vector< string > extensions () const
 A list of preferred file name extensions for this file format. More...
 
map< string, shared_ptr< Option > > options ()
 Options supported by this input format. More...
 
shared_ptr< Inputcreate_input (map< string, Glib::VariantBase > options=map< string, Glib::VariantBase >())
 Create an input using this input format. More...
 

Detailed Description

An input format supported by the library.

Definition at line 791 of file libsigrokcxx.hpp.

Member Function Documentation

string sigrok::InputFormat::name ( ) const

Name of this input format.

string sigrok::InputFormat::description ( ) const

Description of this input format.

vector<string> sigrok::InputFormat::extensions ( ) const

A list of preferred file name extensions for this file format.

Note
This list is a recommendation only.
map<string, shared_ptr<Option> > sigrok::InputFormat::options ( )

Options supported by this input format.

shared_ptr<Input> sigrok::InputFormat::create_input ( map< string, Glib::VariantBase >  options = map< string, Glib::VariantBase >())

Create an input using this input format.

Parameters
optionsMapping of (option name, value) pairs.

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