sigrok::Context Class Reference

The global libsigrok context. More...

#include <libsigrokcxx/libsigrokcxx.hpp>

Inherits sigrok::UserOwned< Class >.

Public Member Functions
std::map< std::string, std::shared_ptr< Driver > >	drivers ()
	Available hardware drivers, indexed by name. More...
std::map< std::string, std::shared_ptr< InputFormat > >	input_formats ()
	Available input formats, indexed by name. More...
std::shared_ptr< InputFormat >	input_format_match (std::string filename)
	Lookup the responsible input module for an input file. More...
std::map< std::string, std::shared_ptr< OutputFormat > >	output_formats ()
	Available output formats, indexed by name. More...
const LogLevel *	log_level () const
	Current log level. More...
void	set_log_level (const LogLevel *level)
	Set the log level. More...
void	set_log_callback (LogCallbackFunction callback)
	Set the log callback. More...
void	set_log_callback_default ()
	Set the log callback to the default handler. More...
void	set_resource_reader (ResourceReader *reader)
	Install a delegate for reading resource files. More...
std::shared_ptr< Session >	create_session ()
	Create a new session. More...
std::shared_ptr< UserDevice >	create_user_device (std::string vendor, std::string model, std::string version)
	Create a new user device. More...
std::shared_ptr< Packet >	create_header_packet (Glib::DateTime start_time)
	Create a header packet. More...
std::shared_ptr< Packet >	create_meta_packet (std::map< const ConfigKey *, Glib::VariantBase > config)
	Create a meta packet. More...
std::shared_ptr< Packet >	create_logic_packet (void *data_pointer, size_t data_length, unsigned int unit_size)
	Create a logic packet. More...
std::shared_ptr< Packet >	create_analog_packet (std::vector< std::shared_ptr< Channel > > channels, const float *data_pointer, unsigned int num_samples, const Quantity *mq, const Unit *unit, std::vector< const QuantityFlag * > mqflags)
	Create an analog packet. More...
std::shared_ptr< Packet >	create_end_packet ()
	Create an end packet. More...
std::shared_ptr< Session >	load_session (std::string filename)
	Load a saved session. More...
std::shared_ptr< Trigger >	create_trigger (std::string name)
	Create a new trigger. More...
std::shared_ptr< Input >	open_file (std::string filename)
	Open an input file. More...
std::shared_ptr< Input >	open_stream (std::string header)
	Open an input stream based on header data. More...
std::map< std::string, std::string >	serials (std::shared_ptr< Driver > driver) const

Static Public Member Functions
static std::shared_ptr< Context >	create ()
	Create new context.
static std::string	package_version ()
	libsigrok package version. More...
static std::string	lib_version ()
	libsigrok library version. More...

Detailed Description

The global libsigrok context.

Definition at line 241 of file libsigrokcxx.hpp.

Member Function Documentation

static std::string sigrok::Context::package_version ( )

static

libsigrok package version.

static std::string sigrok::Context::lib_version ( )

static

libsigrok library version.

std::map<std::string, std::shared_ptr<Driver> > sigrok::Context::drivers

(

)

Available hardware drivers, indexed by name.

std::map<std::string, std::shared_ptr<InputFormat> > sigrok::Context::input_formats

(

)

Available input formats, indexed by name.

std::shared_ptr<InputFormat> sigrok::Context::input_format_match

(

std::string

filename

)

Lookup the responsible input module for an input file.

std::map<std::string, std::shared_ptr<OutputFormat> > sigrok::Context::output_formats

(

)

Available output formats, indexed by name.

const LogLevel* sigrok::Context::log_level

(

)

const

Current log level.

void sigrok::Context::set_log_level

(

const LogLevel *

level

)

Set the log level.

Parameters

level

LogLevel to use.

void sigrok::Context::set_log_callback

(

LogCallbackFunction

callback

)

Set the log callback.

Parameters

callback

Callback of the form callback(LogLevel, string).

void sigrok::Context::set_log_callback_default

(

)

Set the log callback to the default handler.

void sigrok::Context::set_resource_reader

(

ResourceReader *

reader

)

Install a delegate for reading resource files.

Parameters

reader

The resource reader delegate, or nullptr to unset.

std::shared_ptr<Session> sigrok::Context::create_session

(

)

Create a new session.

std::shared_ptr<UserDevice> sigrok::Context::create_user_device	(	std::string	vendor,
		std::string	model,
		std::string	version
	)

Create a new user device.

std::shared_ptr<Packet> sigrok::Context::create_header_packet

(

Glib::DateTime

start_time

)

Create a header packet.

std::shared_ptr<Packet> sigrok::Context::create_meta_packet

(

std::map< const ConfigKey *, Glib::VariantBase >

config

)

Create a meta packet.

std::shared_ptr<Packet> sigrok::Context::create_logic_packet	(	void *	data_pointer,
		size_t	data_length,
		unsigned int	unit_size
	)

Create a logic packet.

std::shared_ptr<Packet> sigrok::Context::create_analog_packet	(	std::vector< std::shared_ptr< Channel > >	channels,
		const float *	data_pointer,
		unsigned int	num_samples,
		const Quantity *	mq,
		const Unit *	unit,
		std::vector< const QuantityFlag * >	mqflags
	)

Create an analog packet.

std::shared_ptr<Packet> sigrok::Context::create_end_packet

(

)

Create an end packet.

std::shared_ptr<Session> sigrok::Context::load_session

(

std::string

filename

)

Load a saved session.

Parameters

filename

File name string.

std::shared_ptr<Trigger> sigrok::Context::create_trigger

(

std::string

name

)

Create a new trigger.

Parameters

name	Name string for new trigger.

std::shared_ptr<Input> sigrok::Context::open_file

(

std::string

filename

)

Open an input file.

Parameters

filename

File name string.

std::shared_ptr<Input> sigrok::Context::open_stream

(

std::string

header

)

Open an input stream based on header data.

Parameters

header

Initial data from stream.

---

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

• include/libsigrokcxx/libsigrokcxx.hpp