sigrok::OutputFormat Class Reference

An output 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 output format. More...
std::string	description () const
	Description of this output 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 output format. More...
std::shared_ptr< Output >	create_output (std::shared_ptr< Device > device, std::map< std::string, Glib::VariantBase > options=std::map< std::string, Glib::VariantBase >())
	Create an output using this format. More...
std::shared_ptr< Output >	create_output (std::string filename, std::shared_ptr< Device > device, std::map< std::string, Glib::VariantBase > options=std::map< std::string, Glib::VariantBase >())
	Create an output using this format. More...
bool	test_flag (const OutputFlag *flag) const
	Checks whether a given flag is set. More...

Detailed Description

An output format supported by the library.

Definition at line 981 of file libsigrokcxx.hpp.

Member Function Documentation

std::string sigrok::OutputFormat::name

(

)

const

Name of this output format.

std::string sigrok::OutputFormat::description

(

)

const

Description of this output format.

std::vector<std::string> sigrok::OutputFormat::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::OutputFormat::options

(

)

Options supported by this output format.

std::shared_ptr<Output> sigrok::OutputFormat::create_output	(	std::shared_ptr< Device >	device,
		std::map< std::string, Glib::VariantBase >	options = std::map< std::string, Glib::VariantBase >()
	)

Create an output using this format.

Parameters

device	Device to output for.
options	Mapping of (option name, value) pairs.

std::shared_ptr<Output> sigrok::OutputFormat::create_output	(	std::string	filename,
		std::shared_ptr< Device >	device,
		std::map< std::string, Glib::VariantBase >	options = std::map< std::string, Glib::VariantBase >()
	)

Create an output using this format.

Parameters

filename	Name of destination file.
device	Device to output for.
options	Mapping of (option name, value) pairs.

bool sigrok::OutputFormat::test_flag

(

const OutputFlag *

flag

)

const

Checks whether a given flag is set.

Parameters

flag	Flag to check

Returns

true if flag is set for this module

See also

sr_output_flags

---

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

• include/libsigrokcxx/libsigrokcxx.hpp