pysigrok  0.4.0
Python bindings for libsigrok
Public Member Functions | List of all members
sigrok.core.classes.Configurable Class Reference

An object that can be configured. More...

+ Inheritance diagram for sigrok.core.classes.Configurable:

Public Member Functions

def config_keys (self)
 Supported configuration keys. More...
 
def config_get (self, key)
 Read configuration for the given key. More...
 
def config_list (self, key)
 Enumerate available values for the given configuration key. More...
 
def config_capabilities (self, key)
 Enumerate configuration capabilities for the given configuration key. More...
 
def config_check (self, key, capability)
 Check whether a configuration capability is supported for a given key. More...
 
def config_set (self, args)
 Set configuration for the given key to a specified value. More...
 

Detailed Description

An object that can be configured.

Member Function Documentation

def sigrok.core.classes.Configurable.config_keys (   self)

Supported configuration keys.

References sigrok.core.classes.Configurable.config_check().

+ Here is the call graph for this function:

def sigrok.core.classes.Configurable.config_get (   self,
  key 
)

Read configuration for the given key.

Parameters
keyConfigKey to read.

References sigrok.core.classes.Configurable.config_set().

+ Here is the call graph for this function:

def sigrok.core.classes.Configurable.config_list (   self,
  key 
)

Enumerate available values for the given configuration key.

Parameters
keyConfigKey to enumerate values for.
def sigrok.core.classes.Configurable.config_capabilities (   self,
  key 
)

Enumerate configuration capabilities for the given configuration key.

Parameters
keyConfigKey to enumerate capabilities for.
def sigrok.core.classes.Configurable.config_check (   self,
  key,
  capability 
)

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

Parameters
capabilityCapability to check for.
keyConfigKey to check.

Referenced by sigrok.core.classes.Configurable.config_keys().

+ Here is the caller graph for this function:

def sigrok.core.classes.Configurable.config_set (   self,
  args 
)

Set configuration for the given key to a specified value.

Parameters
valueValue to set.
keyConfigKey to set.

Referenced by sigrok.core.classes.Configurable.config_get().

+ Here is the caller graph for this function:


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