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

A hardware driver provided by the library. More...

#include <libsigrokcxx/libsigrokcxx.hpp>

+ Inheritance diagram for sigrok::Driver:

Public Member Functions

string name () const
 Name of this driver. More...
 
string long_name () const
 Long name for this driver. More...
 
set< const ConfigKey * > scan_options () const
 Scan options supported by this driver. More...
 
vector< shared_ptr< HardwareDevice > > scan (map< const ConfigKey *, Glib::VariantBase > options=map< const ConfigKey *, Glib::VariantBase >())
 Scan for devices and return a list of devices found. More...
 
- Public Member Functions inherited from sigrok::Configurable
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

A hardware driver provided by the library.

Definition at line 349 of file libsigrokcxx.hpp.

Member Function Documentation

string sigrok::Driver::name ( ) const

Name of this driver.

string sigrok::Driver::long_name ( ) const

Long name for this driver.

set<const ConfigKey *> sigrok::Driver::scan_options ( ) const

Scan options supported by this driver.

vector<shared_ptr<HardwareDevice> > sigrok::Driver::scan ( map< const ConfigKey *, Glib::VariantBase >  options = map< const ConfigKey *, Glib::VariantBase >())

Scan for devices and return a list of devices found.

Parameters
optionsMapping of (ConfigKey, value) pairs.

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