An object that can be configured. More...

Inheritance diagram for sigrok::Configurable:

Public Member Functions
set< const ConfigKey * >	config_keys () const
	Supported configuration keys. More...

Glib::VariantBase	config_get (const ConfigKey *key) const
	Read configuration for the given key. More...

void	config_set (const ConfigKey *key, const Glib::VariantBase &value)
	Set configuration for the given key to a specified value. More...

Glib::VariantContainerBase	config_list (const ConfigKey *key) const
	Enumerate available values for the given configuration key. More...

set< const Capability * >	config_capabilities (const ConfigKey *key) const
	Enumerate configuration capabilities for the given configuration key. More...

bool	config_check (const ConfigKey key, const Capability capability) const
	Check whether a configuration capability is supported for a given key. More...

Detailed Description

An object that can be configured.

Definition at line 315 of file libsigrokcxx.hpp.

Member Function Documentation

set<const ConfigKey *> sigrok::Configurable::config_keys ( ) const

Supported configuration keys.

Glib::VariantBase sigrok::Configurable::config_get ( const ConfigKey * key ) const

Read configuration for the given key.

Parameters

key	ConfigKey to read.

void sigrok::Configurable::config_set	(	const ConfigKey *	key,
		const Glib::VariantBase &	value
	)

Set configuration for the given key to a specified value.

Parameters

key	ConfigKey to set.
value	Value to set.

Glib::VariantContainerBase sigrok::Configurable::config_list ( const ConfigKey * key ) const

Enumerate available values for the given configuration key.

Parameters

key	ConfigKey to enumerate values for.

set<const Capability *> sigrok::Configurable::config_capabilities ( const ConfigKey * key ) const

Enumerate configuration capabilities for the given configuration key.

Parameters

key	ConfigKey to enumerate capabilities for.

bool sigrok::Configurable::config_check	(	const ConfigKey *	key,
		const Capability *	capability
	)		const

Check whether a configuration capability is supported for a given key.

Parameters

key	ConfigKey to check.
capability	Capability to check for.

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