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

Configuration key. More...

#include <libsigrokcxx/enums.hpp>

+ Inheritance diagram for sigrok::ConfigKey:

Public Member Functions

const DataTypedata_type () const
 Data type used for this configuration key. More...
 
string identifier () const
 String identifier for this configuration key, suitable for CLI use. More...
 
string description () const
 Description of this configuration key. More...
 
Glib::VariantBase parse_string (string value) const
 Parse a string argument into the appropriate type for this key. More...
 
- Public Member Functions inherited from sigrok::EnumValue< ConfigKey, enum sr_configkey >
int id () const
 The integer constant associated with this value. More...
 
string name () const
 The name associated with this value. More...
 

Static Public Member Functions

static const ConfigKeyget_by_identifier (string identifier)
 Get configuration key by string identifier. More...
 
- Static Public Member Functions inherited from sigrok::EnumValue< ConfigKey, enum sr_configkey >
static const ConfigKeyget (int id)
 Get value associated with a given integer constant. More...
 
static std::vector< const ConfigKey * > values ()
 Get possible values. More...
 

Static Public Attributes

static const ConfigKey *const LOGIC_ANALYZER
 The device can act as logic analyzer. More...
 
static const ConfigKey *const OSCILLOSCOPE
 The device can act as an oscilloscope. More...
 
static const ConfigKey *const MULTIMETER
 The device can act as a multimeter. More...
 
static const ConfigKey *const DEMO_DEV
 The device is a demo device. More...
 
static const ConfigKey *const SOUNDLEVELMETER
 The device can act as a sound level meter. More...
 
static const ConfigKey *const THERMOMETER
 The device can measure temperature. More...
 
static const ConfigKey *const HYGROMETER
 The device can measure humidity. More...
 
static const ConfigKey *const ENERGYMETER
 The device can measure energy consumption. More...
 
static const ConfigKey *const DEMODULATOR
 The device can act as a signal demodulator. More...
 
static const ConfigKey *const POWER_SUPPLY
 The device can act as a programmable power supply. More...
 
static const ConfigKey *const LCRMETER
 The device can act as an LCR meter. More...
 
static const ConfigKey *const ELECTRONIC_LOAD
 The device can act as an electronic load. More...
 
static const ConfigKey *const SCALE
 The device can act as a scale. More...
 
static const ConfigKey *const CONN
 Specification on how to connect to a device. More...
 
static const ConfigKey *const SERIALCOMM
 Serial communication specification, in the form:
 
static const ConfigKey *const MODBUSADDR
 Modbus slave address specification. More...
 
static const ConfigKey *const SAMPLERATE
 The device supports setting its samplerate, in Hz. More...
 
static const ConfigKey *const CAPTURE_RATIO
 The device supports setting a pre/post-trigger capture ratio. More...
 
static const ConfigKey *const PATTERN_MODE
 The device supports setting a pattern (pattern generator mode). More...
 
static const ConfigKey *const RLE
 The device supports run-length encoding (RLE). More...
 
static const ConfigKey *const TRIGGER_SLOPE
 The device supports setting trigger slope. More...
 
static const ConfigKey *const AVERAGING
 The device supports averaging. More...
 
static const ConfigKey *const AVG_SAMPLES
 The device supports setting number of samples to be averaged over. More...
 
static const ConfigKey *const TRIGGER_SOURCE
 Trigger source. More...
 
static const ConfigKey *const HORIZ_TRIGGERPOS
 Horizontal trigger position. More...
 
static const ConfigKey *const BUFFERSIZE
 Buffer size. More...
 
static const ConfigKey *const TIMEBASE
 Time base. More...
 
static const ConfigKey *const FILTER
 Filter. More...
 
static const ConfigKey *const VDIV
 Volts/div. More...
 
static const ConfigKey *const COUPLING
 Coupling. More...
 
static const ConfigKey *const TRIGGER_MATCH
 Trigger matches. More...
 
static const ConfigKey *const SAMPLE_INTERVAL
 The device supports setting its sample interval, in ms. More...
 
static const ConfigKey *const NUM_HDIV
 Number of horizontal divisions, as related to SR_CONF_TIMEBASE. More...
 
static const ConfigKey *const NUM_VDIV
 Number of vertical divisions, as related to SR_CONF_VDIV. More...
 
static const ConfigKey *const SPL_WEIGHT_FREQ
 Sound pressure level frequency weighting. More...
 
static const ConfigKey *const SPL_WEIGHT_TIME
 Sound pressure level time weighting. More...
 
static const ConfigKey *const SPL_MEASUREMENT_RANGE
 Sound pressure level measurement range. More...
 
static const ConfigKey *const HOLD_MAX
 Max hold mode. More...
 
static const ConfigKey *const HOLD_MIN
 Min hold mode. More...
 
static const ConfigKey *const VOLTAGE_THRESHOLD
 Logic low-high threshold range. More...
 
static const ConfigKey *const EXTERNAL_CLOCK
 The device supports using an external clock. More...
 
static const ConfigKey *const SWAP
 The device supports swapping channels. More...
 
static const ConfigKey *const CENTER_FREQUENCY
 Center frequency. More...
 
static const ConfigKey *const NUM_LOGIC_CHANNELS
 The device supports setting the number of logic channels. More...
 
static const ConfigKey *const NUM_ANALOG_CHANNELS
 The device supports setting the number of analog channels. More...
 
static const ConfigKey *const VOLTAGE
 Current voltage. More...
 
static const ConfigKey *const VOLTAGE_TARGET
 Maximum target voltage. More...
 
static const ConfigKey *const CURRENT
 Current current. More...
 
static const ConfigKey *const CURRENT_LIMIT
 Current limit. More...
 
static const ConfigKey *const ENABLED
 Enabling/disabling channel. More...
 
static const ConfigKey *const CHANNEL_CONFIG
 Channel configuration. More...
 
static const ConfigKey *const OVER_VOLTAGE_PROTECTION_ENABLED
 Over-voltage protection (OVP) feature. More...
 
static const ConfigKey *const OVER_VOLTAGE_PROTECTION_ACTIVE
 Over-voltage protection (OVP) active. More...
 
static const ConfigKey *const OVER_VOLTAGE_PROTECTION_THRESHOLD
 Over-voltage protection (OVP) threshold. More...
 
static const ConfigKey *const OVER_CURRENT_PROTECTION_ENABLED
 Over-current protection (OCP) feature. More...
 
static const ConfigKey *const OVER_CURRENT_PROTECTION_ACTIVE
 Over-current protection (OCP) active. More...
 
static const ConfigKey *const OVER_CURRENT_PROTECTION_THRESHOLD
 Over-current protection (OCP) threshold. More...
 
static const ConfigKey *const CLOCK_EDGE
 Choice of clock edge for external clock ("r" or "f"). More...
 
static const ConfigKey *const AMPLITUDE
 Amplitude of a source without strictly-defined MQ. More...
 
static const ConfigKey *const REGULATION
 Channel regulation get: "CV", "CC" or "UR", denoting constant voltage, constant current or unregulated. More...
 
static const ConfigKey *const OVER_TEMPERATURE_PROTECTION
 Over-temperature protection (OTP)
 
static const ConfigKey *const OUTPUT_FREQUENCY
 Output frequency in Hz. More...
 
static const ConfigKey *const OUTPUT_FREQUENCY_TARGET
 Output frequency target in Hz. More...
 
static const ConfigKey *const MEASURED_QUANTITY
 Measured quantity. More...
 
static const ConfigKey *const EQUIV_CIRCUIT_MODEL
 Equivalent circuit model. More...
 
static const ConfigKey *const OVER_TEMPERATURE_PROTECTION_ACTIVE
 Over-temperature protection (OTP) active. More...
 
static const ConfigKey *const SESSIONFILE
 Session filename. More...
 
static const ConfigKey *const CAPTUREFILE
 The device supports specifying a capturefile to inject. More...
 
static const ConfigKey *const CAPTURE_UNITSIZE
 The device supports specifying the capturefile unit size. More...
 
static const ConfigKey *const POWER_OFF
 Power off the device. More...
 
static const ConfigKey *const DATA_SOURCE
 Data source for acquisition. More...
 
static const ConfigKey *const PROBE_FACTOR
 The device supports setting a probe factor. More...
 
static const ConfigKey *const LIMIT_MSEC
 The device supports setting a sample time limit (how long the sample acquisition should run, in ms). More...
 
static const ConfigKey *const LIMIT_SAMPLES
 The device supports setting a sample number limit (how many samples should be acquired). More...
 
static const ConfigKey *const LIMIT_FRAMES
 The device supports setting a frame limit (how many frames should be acquired). More...
 
static const ConfigKey *const CONTINUOUS
 The device supports continuous sampling. More...
 
static const ConfigKey *const DATALOG
 The device has internal storage, into which data is logged. More...
 
static const ConfigKey *const DEVICE_MODE
 Device mode for multi-function devices. More...
 
static const ConfigKey *const TEST_MODE
 Self test mode. More...
 

Detailed Description

Configuration key.

Definition at line 484 of file enums.hpp.

Member Function Documentation

const DataType* sigrok::ConfigKey::data_type ( ) const

Data type used for this configuration key.

string sigrok::ConfigKey::identifier ( ) const

String identifier for this configuration key, suitable for CLI use.

string sigrok::ConfigKey::description ( ) const

Description of this configuration key.

static const ConfigKey* sigrok::ConfigKey::get_by_identifier ( string  identifier)
static

Get configuration key by string identifier.

Glib::VariantBase sigrok::ConfigKey::parse_string ( string  value) const

Parse a string argument into the appropriate type for this key.

Member Data Documentation

const ConfigKey* const sigrok::ConfigKey::LOGIC_ANALYZER
static

The device can act as logic analyzer.

Definition at line 489 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::OSCILLOSCOPE
static

The device can act as an oscilloscope.

Definition at line 491 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::MULTIMETER
static

The device can act as a multimeter.

Definition at line 493 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::DEMO_DEV
static

The device is a demo device.

Definition at line 495 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::SOUNDLEVELMETER
static

The device can act as a sound level meter.

Definition at line 497 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::THERMOMETER
static

The device can measure temperature.

Definition at line 499 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::HYGROMETER
static

The device can measure humidity.

Definition at line 501 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::ENERGYMETER
static

The device can measure energy consumption.

Definition at line 503 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::DEMODULATOR
static

The device can act as a signal demodulator.

Definition at line 505 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::POWER_SUPPLY
static

The device can act as a programmable power supply.

Definition at line 507 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::LCRMETER
static

The device can act as an LCR meter.

Definition at line 509 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::ELECTRONIC_LOAD
static

The device can act as an electronic load.

Definition at line 511 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::SCALE
static

The device can act as a scale.

Definition at line 513 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::CONN
static

Specification on how to connect to a device.

Definition at line 515 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::MODBUSADDR
static

Modbus slave address specification.

Definition at line 519 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::SAMPLERATE
static

The device supports setting its samplerate, in Hz.

Definition at line 521 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::CAPTURE_RATIO
static

The device supports setting a pre/post-trigger capture ratio.

Definition at line 523 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::PATTERN_MODE
static

The device supports setting a pattern (pattern generator mode).

Definition at line 525 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::RLE
static

The device supports run-length encoding (RLE).

Definition at line 527 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::TRIGGER_SLOPE
static

The device supports setting trigger slope.

Definition at line 529 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::AVERAGING
static

The device supports averaging.

Definition at line 531 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::AVG_SAMPLES
static

The device supports setting number of samples to be averaged over.

Definition at line 533 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::TRIGGER_SOURCE
static

Trigger source.

Definition at line 535 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::HORIZ_TRIGGERPOS
static

Horizontal trigger position.

Definition at line 537 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::BUFFERSIZE
static

Buffer size.

Definition at line 539 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::TIMEBASE
static

Time base.

Definition at line 541 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::FILTER
static

Filter.

Definition at line 543 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::VDIV
static

Volts/div.

Definition at line 545 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::COUPLING
static

Coupling.

Definition at line 547 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::TRIGGER_MATCH
static

Trigger matches.

Definition at line 549 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::SAMPLE_INTERVAL
static

The device supports setting its sample interval, in ms.

Definition at line 551 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::NUM_HDIV
static

Number of horizontal divisions, as related to SR_CONF_TIMEBASE.

Definition at line 553 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::NUM_VDIV
static

Number of vertical divisions, as related to SR_CONF_VDIV.

Definition at line 555 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::SPL_WEIGHT_FREQ
static

Sound pressure level frequency weighting.

Definition at line 557 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::SPL_WEIGHT_TIME
static

Sound pressure level time weighting.

Definition at line 559 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::SPL_MEASUREMENT_RANGE
static

Sound pressure level measurement range.

Definition at line 561 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::HOLD_MAX
static

Max hold mode.

Definition at line 563 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::HOLD_MIN
static

Min hold mode.

Definition at line 565 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::VOLTAGE_THRESHOLD
static

Logic low-high threshold range.

Definition at line 567 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::EXTERNAL_CLOCK
static

The device supports using an external clock.

Definition at line 569 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::SWAP
static

The device supports swapping channels.

Definition at line 571 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::CENTER_FREQUENCY
static

Center frequency.

Definition at line 573 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::NUM_LOGIC_CHANNELS
static

The device supports setting the number of logic channels.

Definition at line 575 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::NUM_ANALOG_CHANNELS
static

The device supports setting the number of analog channels.

Definition at line 577 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::VOLTAGE
static

Current voltage.

Definition at line 579 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::VOLTAGE_TARGET
static

Maximum target voltage.

Definition at line 581 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::CURRENT
static

Current current.

Definition at line 583 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::CURRENT_LIMIT
static

Current limit.

Definition at line 585 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::ENABLED
static

Enabling/disabling channel.

Definition at line 587 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::CHANNEL_CONFIG
static

Channel configuration.

Definition at line 589 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::OVER_VOLTAGE_PROTECTION_ENABLED
static

Over-voltage protection (OVP) feature.

Definition at line 591 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::OVER_VOLTAGE_PROTECTION_ACTIVE
static

Over-voltage protection (OVP) active.

Definition at line 593 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::OVER_VOLTAGE_PROTECTION_THRESHOLD
static

Over-voltage protection (OVP) threshold.

Definition at line 595 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::OVER_CURRENT_PROTECTION_ENABLED
static

Over-current protection (OCP) feature.

Definition at line 597 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::OVER_CURRENT_PROTECTION_ACTIVE
static

Over-current protection (OCP) active.

Definition at line 599 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::OVER_CURRENT_PROTECTION_THRESHOLD
static

Over-current protection (OCP) threshold.

Definition at line 601 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::CLOCK_EDGE
static

Choice of clock edge for external clock ("r" or "f").

Definition at line 603 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::AMPLITUDE
static

Amplitude of a source without strictly-defined MQ.

Definition at line 605 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::REGULATION
static

Channel regulation get: "CV", "CC" or "UR", denoting constant voltage, constant current or unregulated.

Definition at line 607 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::OUTPUT_FREQUENCY
static

Output frequency in Hz.

Definition at line 611 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::OUTPUT_FREQUENCY_TARGET
static

Output frequency target in Hz.

Definition at line 613 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::MEASURED_QUANTITY
static

Measured quantity.

Definition at line 615 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::EQUIV_CIRCUIT_MODEL
static

Equivalent circuit model.

Definition at line 617 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::OVER_TEMPERATURE_PROTECTION_ACTIVE
static

Over-temperature protection (OTP) active.

Definition at line 619 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::SESSIONFILE
static

Session filename.

Definition at line 621 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::CAPTUREFILE
static

The device supports specifying a capturefile to inject.

Definition at line 623 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::CAPTURE_UNITSIZE
static

The device supports specifying the capturefile unit size.

Definition at line 625 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::POWER_OFF
static

Power off the device.

Definition at line 627 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::DATA_SOURCE
static

Data source for acquisition.

Definition at line 629 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::PROBE_FACTOR
static

The device supports setting a probe factor.

Definition at line 631 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::LIMIT_MSEC
static

The device supports setting a sample time limit (how long the sample acquisition should run, in ms).

Definition at line 633 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::LIMIT_SAMPLES
static

The device supports setting a sample number limit (how many samples should be acquired).

Definition at line 635 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::LIMIT_FRAMES
static

The device supports setting a frame limit (how many frames should be acquired).

Definition at line 637 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::CONTINUOUS
static

The device supports continuous sampling.

Definition at line 639 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::DATALOG
static

The device has internal storage, into which data is logged.

Definition at line 641 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::DEVICE_MODE
static

Device mode for multi-function devices.

Definition at line 643 of file enums.hpp.

const ConfigKey* const sigrok::ConfigKey::TEST_MODE
static

Self test mode.

Definition at line 645 of file enums.hpp.


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