libsigrokcxx  unreleased development snapshot
C++ bindings for libsigrok
Public Member Functions | List of all members
sigrok::Device Class Referenceabstract

A generic device, either hardware or virtual. More...

#include <libsigrokcxx/libsigrokcxx.hpp>

+ Inheritance diagram for sigrok::Device:

Public Member Functions

std::string vendor () const
 Vendor name for this device. More...
 
std::string model () const
 Model name for this device. More...
 
std::string version () const
 Version string for this device. More...
 
std::string serial_number () const
 Serial number for this device. More...
 
std::string connection_id () const
 Connection ID for this device. More...
 
std::vector< std::shared_ptr< Channel > > channels ()
 List of the channels available on this device. More...
 
std::map< std::string, std::shared_ptr< ChannelGroup > > channel_groups ()
 Channel groups available on this device, indexed by name. More...
 
void open ()
 Open device. More...
 
void close ()
 Close device. More...
 
- Public Member Functions inherited from sigrok::Configurable
std::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...
 
std::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 generic device, either hardware or virtual.

Definition at line 379 of file libsigrokcxx.hpp.

Member Function Documentation

std::string sigrok::Device::vendor ( ) const

Vendor name for this device.

std::string sigrok::Device::model ( ) const

Model name for this device.

std::string sigrok::Device::version ( ) const

Version string for this device.

std::string sigrok::Device::serial_number ( ) const

Serial number for this device.

std::string sigrok::Device::connection_id ( ) const

Connection ID for this device.

std::vector<std::shared_ptr<Channel> > sigrok::Device::channels ( )

List of the channels available on this device.

std::map<std::string, std::shared_ptr<ChannelGroup> > sigrok::Device::channel_groups ( )

Channel groups available on this device, indexed by name.

void sigrok::Device::open ( )

Open device.

void sigrok::Device::close ( )

Close device.


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