sigrok::InputFormat Class Reference

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

#include <libsigrokcxx/libsigrokcxx.hpp>

Inherits sigrok::ParentOwned< Class, Parent >.

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

Detailed Description

An input format supported by the library.

Definition at line 885 of file libsigrokcxx.hpp.

Member Function Documentation

std::string sigrok::InputFormat::name

(

)

const

Name of this input format.

std::string sigrok::InputFormat::description

(

)

const

Description of this input format.

std::vector<std::string> sigrok::InputFormat::extensions

(

)

const

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

Note

This list is a recommendation only.

std::map<std::string, std::shared_ptr<Option> > sigrok::InputFormat::options

(

)

Options supported by this input format.

std::shared_ptr<Input> sigrok::InputFormat::create_input

(

std::map< std::string, Glib::VariantBase >

options = std::map< std::string, Glib::VariantBase >()

)

Create an input using this input format.

Parameters

options

Mapping of (option name, value) pairs.

---

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

• include/libsigrokcxx/libsigrokcxx.hpp