bindings/cxx/include/libsigrok/libsigrok.hpp

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013-2014 Martin Ling <martin-sigrok@earth.li>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /**
  21
  22 @mainpage API Reference
  23
  24 Introduction
  25 ------------
  26
  27 The sigrok++ API provides an object-oriented C++ interface to the functionality
  28 in libsigrok, including automatic memory and resource management.
  29
  30 It is built on top of the public libsigrok C API, and is designed to be used as
  31 a standalone alternative API. Programs should not mix usage of the C and C++
  32 APIs; the C++ interface code needs to have full control of all C API calls for
  33 resources to be managed correctly.
  34
  35 Memory management
  36 -----------------
  37
  38 All runtime objects created through the C++ API are passed and accessed via
  39 shared pointers, using the C++11 std::shared_ptr implementation. This means
  40 that a reference count is kept for each object.
  41
  42 Shared pointers can be copied and assigned in a user's program, automatically
  43 updating their reference count and deleting objects when they are no longer in
  44 use. The C++ interface code also keeps track of internal dependencies between
  45 libsigrok resources, and ensures that objects are not prematurely deleted when
  46 their resources are in use by other objects.
  47
  48 This means that management of sigrok++ objects and their underlying libsigrok
  49 resources can be treated as fully automatic. As long as all shared pointers to
  50 objects are deleted or reassigned when no longer in use, all underlying
  51 resources will be released at the right time.
  52
  53 Getting started
  54 ---------------
  55
  56 Usage of the C++ API needs to begin with a call to sigrok::Context::create().
  57 This will create the global libsigrok context and returns a shared pointer to
  58 the sigrok::Context object. Methods on this object provide access to the
  59 hardware drivers, input and output formats supported by the library, as well
  60 as means of creating other objects such as sessions and triggers.
  61
  62 Error handling
  63 --------------
  64
  65 When any libsigrok C API call returns an error, a sigrok::Error exception is
  66 raised, which provides access to the error code and description.
  67
  68 */
  69
  70 #ifndef LIBSIGROK_HPP
  71 #define LIBSIGROK_HPP
  72
  73 #include "libsigrok/libsigrok.h"
  74 #include <glibmm-2.4/glibmm.h>
  75
  76 #include <stdexcept>
  77 #include <memory>
  78 #include <vector>
  79 #include <map>
  80
  81 namespace sigrok
  82 {
  83
  84 using namespace std;
  85
  86 /* Forward declarations */
  87 class SR_API Error;
  88 class SR_API Context;
  89 class SR_API Driver;
  90 class SR_API Device;
  91 class SR_API HardwareDevice;
  92 class SR_API Channel;
  93 class SR_API EventSource;
  94 class SR_API Session;
  95 class SR_API ConfigKey;
  96 class SR_API InputFormat;
  97 class SR_API OutputFormat;
  98 class SR_API LogLevel;
  99 class SR_API ChannelGroup;
 100 class SR_API Trigger;
 101 class SR_API TriggerStage;
 102 class SR_API TriggerMatch;
 103 class SR_API TriggerMatchType;
 104 class SR_API ChannelType;
 105 class SR_API Packet;
 106 class SR_API PacketPayload;
 107 class SR_API PacketType;
 108 class SR_API Quantity;
 109 class SR_API Unit;
 110 class SR_API QuantityFlag;
 111 class SR_API InputFileDevice;
 112 class SR_API Output;
 113 class SR_API DataType;
 114
 115 /** Exception thrown when an error code is returned by any libsigrok call. */
 116 class SR_API Error: public exception
 117 {
 118 public:
 119         Error(int result);
 120         ~Error() throw();
 121         const int result;
 122         const char *what() const throw();
 123 };
 124
 125 /* Base template for most classes which wrap a struct type from libsigrok. */
 126 template <class Parent, typename Struct> class SR_API StructureWrapper :
 127         public enable_shared_from_this<StructureWrapper<Parent, Struct> >
 128 {
 129 protected:
 130         /*  Parent object which owns this child object's underlying structure.
 131
 132                 This shared pointer will be null when this child is unused, but
 133                 will be assigned to point to the parent before any shared pointer
 134                 to this child is handed out to the user.
 135
 136                 When the reference count of this child falls to zero, this shared
 137                 pointer to its parent is reset by a custom deleter on the child's
 138                 shared pointer.
 139
 140                 This strategy ensures that the destructors for both the child and
 141                 the parent are called at the correct time, i.e. only when all
 142                 references to both the parent and all its children are gone. */
 143         shared_ptr<Parent> parent;
 144
 145 public:
 146         shared_ptr<StructureWrapper<Parent, Struct> >
 147         get_shared_pointer(Parent *parent)
 148         {
 149                 this->parent = static_pointer_cast<Parent>(parent->shared_from_this());
 150                 return shared_ptr<StructureWrapper<Parent, Struct> >(
 151                         this, reset_parent);
 152         }
 153         shared_ptr<StructureWrapper<Parent, Struct> >
 154         get_shared_pointer(shared_ptr<Parent> parent)
 155         {
 156                 this->parent = parent;
 157                 return shared_ptr<StructureWrapper<Parent, Struct> >(
 158                         this, reset_parent);
 159         }
 160 protected:
 161         static void reset_parent(StructureWrapper<Parent, Struct> *object)
 162         {
 163                 object->parent.reset();
 164         }
 165
 166         Struct *structure;
 167
 168         StructureWrapper<Parent, Struct>(Struct *structure) :
 169                 structure(structure)
 170         {
 171         }
 172 };
 173
 174 /** Type of log callback */
 175 typedef function<void(const LogLevel *, string message)> LogCallbackFunction;
 176
 177 /** The global libsigrok context */
 178 class SR_API Context : public enable_shared_from_this<Context>
 179 {
 180 public:
 181         /** Create new context */
 182         static shared_ptr<Context> create();
 183         /** libsigrok package version. */
 184         string get_package_version();
 185         /** libsigrok library version. */
 186         string get_lib_version();
 187         /** Available hardware drivers, indexed by name. */
 188         map<string, shared_ptr<Driver> > get_drivers();
 189         /** Available input formats, indexed by name. */
 190         map<string, shared_ptr<InputFormat> > get_input_formats();
 191         /** Available output formats, indexed by name. */
 192         map<string, shared_ptr<OutputFormat> > get_output_formats();
 193         /** Current log level. */
 194         const LogLevel *get_log_level();
 195         /** Set the log level. */
 196         void set_log_level(const LogLevel *level);
 197         /** Current log domain. */
 198         string get_log_domain();
 199         /** Set the log domain. */
 200         void set_log_domain(string value);
 201         /** Set the log callback. */
 202         void set_log_callback(LogCallbackFunction callback);
 203         /** Set the log callback to the default handler. */
 204         void set_log_callback_default();
 205         /** Create a new session. */
 206         shared_ptr<Session> create_session();
 207         /** Load a saved session. */
 208         shared_ptr<Session> load_session(string filename);
 209         /** Create a new trigger. */
 210         shared_ptr<Trigger> create_trigger(string name);
 211 protected:
 212         struct sr_context *structure;
 213         map<string, Driver *> drivers;
 214         map<string, InputFormat *> input_formats;
 215         map<string, OutputFormat *> output_formats;
 216         Session *session;
 217         LogCallbackFunction log_callback;
 218         Context();
 219         ~Context();
 220         /** Deleter needed to allow shared_ptr use with protected destructor. */
 221         class Deleter
 222         {
 223         public:
 224                 void operator()(Context *context) { delete context; }
 225         };
 226         friend class Deleter;
 227         friend class Session;
 228         friend class Driver;
 229 };
 230
 231 /** A hardware driver provided by the library */
 232 class SR_API Driver : public StructureWrapper<Context, struct sr_dev_driver>
 233 {
 234 public:
 235         /** Name of this driver. */
 236         string get_name();
 237         /** Long name for this driver. */
 238         string get_long_name();
 239         /** Scan for devices and return a list of devices found. */
 240         vector<shared_ptr<HardwareDevice> > scan(
 241                 map<const ConfigKey *, Glib::VariantBase> options = {});
 242 protected:
 243         bool initialized;
 244         vector<HardwareDevice *> devices;
 245         Driver(struct sr_dev_driver *structure);
 246         ~Driver();
 247         friend class Context;
 248         friend class HardwareDevice;
 249         friend class ChannelGroup;
 250 };
 251
 252 /** An object that can be configured. */
 253 class SR_API Configurable
 254 {
 255 public:
 256         /** Read configuration for the given key. */
 257         Glib::VariantBase config_get(const ConfigKey *key);
 258         /** Set configuration for the given key to a specified value. */
 259         void config_set(const ConfigKey *key, Glib::VariantBase value);
 260         /** Enumerate available values for the given configuration key. */
 261         Glib::VariantBase config_list(const ConfigKey *key);
 262 protected:
 263         Configurable(
 264                 struct sr_dev_driver *driver,
 265                 struct sr_dev_inst *sdi,
 266                 struct sr_channel_group *channel_group);
 267         virtual ~Configurable();
 268         struct sr_dev_driver *config_driver;
 269         struct sr_dev_inst *config_sdi;
 270         struct sr_channel_group *config_channel_group;
 271 };
 272
 273 /** A generic device, either hardware or virtual */
 274 class SR_API Device :
 275         public Configurable,
 276         public StructureWrapper<Context, struct sr_dev_inst>
 277 {
 278 public:
 279         /** Vendor name for this device. */
 280         string get_vendor();
 281         /** Model name for this device. */
 282         string get_model();
 283         /** Version string for this device. */
 284         string get_version();
 285         /** List of the channels available on this device. */
 286         vector<shared_ptr<Channel> > get_channels();
 287         /** Open device. */
 288         void open();
 289         /** Close device. */
 290         void close();
 291 protected:
 292         Device(struct sr_dev_inst *structure);
 293         ~Device();
 294         shared_ptr<Channel> get_channel(struct sr_channel *ptr);
 295         map<struct sr_channel *, Channel *> channels;
 296         /** Deleter needed to allow shared_ptr use with protected destructor. */
 297         class Deleter
 298         {
 299         public:
 300                 void operator()(Device *device) { delete device; }
 301         };
 302         friend class Deleter;
 303         friend class Session;
 304         friend class Channel;
 305         friend class ChannelGroup;
 306         friend class Output;
 307 };
 308
 309 /** A real hardware device, connected via a driver */
 310 class SR_API HardwareDevice : public Device
 311 {
 312 public:
 313         /** Driver providing this device. */
 314         shared_ptr<Driver> get_driver();
 315         /** Channel groups available on this device, indexed by name. */
 316         map<string, shared_ptr<ChannelGroup> > get_channel_groups();
 317 protected:
 318         HardwareDevice(Driver *driver, struct sr_dev_inst *structure);
 319         ~HardwareDevice();
 320         Driver *driver;
 321         map<string, ChannelGroup *> channel_groups;
 322         friend class Driver;
 323         friend class ChannelGroup;
 324 };
 325
 326 /** A channel on a device */
 327 class SR_API Channel : public StructureWrapper<Device, struct sr_channel>
 328 {
 329 public:
 330         /** Current name of this channel. */
 331         string get_name();
 332         /** Set the name of this channel. */
 333         void set_name(string name);
 334         /** Type of this channel. */
 335         const ChannelType *get_type();
 336         /** Enabled status of this channel. */
 337         bool get_enabled();
 338         /** Set the enabled status of this channel. */
 339         void set_enabled(bool value);
 340 protected:
 341         Channel(struct sr_channel *structure);
 342         ~Channel();
 343         const ChannelType * const type;
 344         friend class Device;
 345         friend class ChannelGroup;
 346         friend class Session;
 347         friend class TriggerStage;
 348 };
 349
 350 /** A group of channels on a device, which share some configuration */
 351 class SR_API ChannelGroup :
 352         public StructureWrapper<HardwareDevice, struct sr_channel_group>,
 353         public Configurable
 354 {
 355 public:
 356         /** Name of this channel group. */
 357         string get_name();
 358         /** List of the channels in this group. */
 359         vector<shared_ptr<Channel> > get_channels();
 360 protected:
 361         ChannelGroup(HardwareDevice *device, struct sr_channel_group *structure);
 362         ~ChannelGroup();
 363         vector<Channel *> channels;
 364         friend class HardwareDevice;
 365 };
 366
 367 /** A trigger configuration */
 368 class SR_API Trigger : public enable_shared_from_this<Trigger>
 369 {
 370 public:
 371         string get_name();
 372         vector<shared_ptr<TriggerStage> > get_stages();
 373         shared_ptr<TriggerStage> add_stage();
 374 protected:
 375         Trigger(shared_ptr<Context> context, string name);
 376         ~Trigger();
 377         struct sr_trigger *structure;
 378         shared_ptr<Context> context;
 379         vector<TriggerStage *> stages;
 380         /** Deleter needed to allow shared_ptr use with protected destructor. */
 381         class Deleter
 382         {
 383         public:
 384                 void operator()(Trigger *trigger) { delete trigger; }
 385         };
 386         friend class Context;
 387         friend class Session;
 388 };
 389
 390 /** A stage in a trigger configuration */
 391 class SR_API TriggerStage : public StructureWrapper<Trigger, struct sr_trigger_stage>
 392 {
 393 public:
 394         int get_number();
 395         vector<shared_ptr<TriggerMatch> > get_matches();
 396         void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type);
 397         void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value);
 398 protected:
 399         vector<TriggerMatch *> matches;
 400         TriggerStage(struct sr_trigger_stage *structure);
 401         ~TriggerStage();
 402         friend class Trigger;
 403 };
 404
 405 /** A match condition in a trigger configuration  */
 406 class SR_API TriggerMatch : public StructureWrapper<TriggerStage, struct sr_trigger_match>
 407 {
 408 public:
 409         shared_ptr<Channel> get_channel();
 410         const TriggerMatchType *get_type();
 411         float get_value();
 412 protected:
 413         TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel);
 414         ~TriggerMatch();
 415         shared_ptr<Channel> channel;
 416         friend class TriggerStage;
 417 };
 418
 419 /** Type of datafeed callback */
 420 typedef function<void(shared_ptr<Device>, shared_ptr<Packet>)>
 421         DatafeedCallbackFunction;
 422
 423 /* Data required for C callback function to call a C++ datafeed callback */
 424 class SR_PRIV DatafeedCallbackData
 425 {
 426 public:
 427         void run(const struct sr_dev_inst *sdi,
 428                 const struct sr_datafeed_packet *pkt);
 429 protected:
 430         DatafeedCallbackFunction callback;
 431         DatafeedCallbackData(Session *session,
 432                 DatafeedCallbackFunction callback);
 433         Session *session;
 434         friend class Session;
 435 };
 436
 437 /** Type of source callback */
 438 typedef function<bool(Glib::IOCondition)>
 439         SourceCallbackFunction;
 440
 441 /* Data required for C callback function to call a C++ source callback */
 442 class SR_PRIV SourceCallbackData
 443 {
 444 public:
 445         bool run(int revents);
 446 protected:
 447         SourceCallbackData(shared_ptr<EventSource> source);
 448         shared_ptr<EventSource> source;
 449         friend class Session;
 450 };
 451
 452 /** An I/O event source */
 453 class SR_API EventSource
 454 {
 455 public:
 456         /** Create an event source from a file descriptor. */
 457         static shared_ptr<EventSource> create(int fd, Glib::IOCondition events,
 458                 int timeout, SourceCallbackFunction callback);
 459         /** Create an event source from a Glib::PollFD */
 460         static shared_ptr<EventSource> create(Glib::PollFD pollfd, int timeout,
 461                 SourceCallbackFunction callback);
 462         /** Create an event source from a Glib::IOChannel */
 463         static shared_ptr<EventSource> create(
 464                 Glib::RefPtr<Glib::IOChannel> channel, Glib::IOCondition events,
 465                 int timeout, SourceCallbackFunction callback);
 466 protected:
 467         EventSource(int timeout, SourceCallbackFunction callback);
 468         ~EventSource();
 469         enum source_type {
 470                 SOURCE_FD,
 471                 SOURCE_POLLFD,
 472                 SOURCE_IOCHANNEL
 473         } type;
 474         int fd;
 475         Glib::PollFD pollfd;
 476         Glib::RefPtr<Glib::IOChannel> channel;
 477         Glib::IOCondition events;
 478         int timeout;
 479         SourceCallbackFunction callback;
 480         /** Deleter needed to allow shared_ptr use with protected destructor. */
 481         class Deleter
 482         {
 483         public:
 484                 void operator()(EventSource *source) { delete source; }
 485         };
 486         friend class Deleter;
 487         friend class Session;
 488         friend class SourceCallbackData;
 489 };
 490
 491 /** A sigrok session */
 492 class SR_API Session
 493 {
 494 public:
 495         /** Add a device to this session. */
 496         void add_device(shared_ptr<Device> device);
 497         /** List devices attached to this session. */
 498         vector<shared_ptr<Device> > get_devices();
 499         /** Remove all devices from this session. */
 500         void remove_devices();
 501         /** Add a datafeed callback to this session. */
 502         void add_datafeed_callback(DatafeedCallbackFunction callback);
 503         /** Remove all datafeed callbacks from this session. */
 504         void remove_datafeed_callbacks();
 505         /** Add an event source. */
 506         void add_source(shared_ptr<EventSource> source);
 507         /** Remove an event source. */
 508         void remove_source(shared_ptr<EventSource> source);
 509         /** Start the session. */
 510         void start();
 511         /** Run the session event loop. */
 512         void run();
 513         /** Stop the session. */
 514         void stop();
 515         /** Begin saving session to a file. */
 516         void begin_save(string filename);
 517         /** Append a packet to the session file being saved. */
 518         void append(shared_ptr<Device> device, shared_ptr<Packet> packet);
 519         /** Get current trigger setting. */
 520         shared_ptr<Trigger> get_trigger();
 521         /** Set trigger setting. */
 522         void set_trigger(shared_ptr<Trigger> trigger);
 523 protected:
 524         Session(shared_ptr<Context> context);
 525         Session(shared_ptr<Context> context, string filename);
 526         ~Session();
 527         struct sr_session *structure;
 528         const shared_ptr<Context> context;
 529         map<const struct sr_dev_inst *, shared_ptr<Device> > devices;
 530         vector<DatafeedCallbackData *> datafeed_callbacks;
 531         map<shared_ptr<EventSource>, SourceCallbackData *> source_callbacks;
 532         bool saving;
 533         bool save_initialized;
 534         string save_filename;
 535         uint64_t save_samplerate;
 536         shared_ptr<Trigger> trigger;
 537         /** Deleter needed to allow shared_ptr use with protected destructor. */
 538         class Deleter
 539         {
 540         public:
 541                 void operator()(Session *session) { delete session; }
 542         };
 543         friend class Deleter;
 544         friend class Context;
 545         friend class DatafeedCallbackData;
 546 };
 547
 548 /** A packet on the session datafeed */
 549 class SR_API Packet
 550 {
 551 public:
 552         /** Type of this packet. */
 553         const PacketType *get_type();
 554         /** Payload of this packet. */
 555         PacketPayload *get_payload();
 556 protected:
 557         Packet(const struct sr_datafeed_packet *structure);
 558         ~Packet();
 559         const struct sr_datafeed_packet *structure;
 560         PacketPayload *payload;
 561         /** Deleter needed to allow shared_ptr use with protected destructor. */
 562         class Deleter
 563         {
 564         public:
 565                 void operator()(Packet *packet) { delete packet; }
 566         };
 567         friend class Deleter;
 568         friend class Session;
 569         friend class Output;
 570         friend class DatafeedCallbackData;
 571 };
 572
 573 /** Abstract base class for datafeed packet payloads */
 574 class SR_API PacketPayload
 575 {
 576 protected:
 577         PacketPayload();
 578         virtual ~PacketPayload() = 0;
 579         virtual void *get_data() = 0;
 580         virtual size_t get_data_size() = 0;
 581         friend class Packet;
 582         friend class Output;
 583 };
 584
 585 /** Payload of a datafeed packet with logic data */
 586 class SR_API Logic : public PacketPayload
 587 {
 588 protected:
 589         Logic(const struct sr_datafeed_logic *structure);
 590         ~Logic();
 591         const struct sr_datafeed_logic *structure;
 592         vector<uint8_t> data;
 593         void *get_data();
 594         size_t get_data_size();
 595         friend class Packet;
 596 };
 597
 598 /** Payload of a datafeed packet with analog data */
 599 class SR_API Analog : public PacketPayload
 600 {
 601 public:
 602         /** Number of samples in this packet. */
 603         unsigned int get_num_samples();
 604         /** Measured quantity of the samples in this packet. */
 605         const Quantity *get_mq();
 606         /** Unit of the samples in this packet. */
 607         const Unit *get_unit();
 608         /** Measurement flags associated with the samples in this packet. */
 609         vector<const QuantityFlag *> get_mq_flags();
 610 protected:
 611         Analog(const struct sr_datafeed_analog *structure);
 612         ~Analog();
 613         const struct sr_datafeed_analog *structure;
 614         void *get_data();
 615         size_t get_data_size();
 616         friend class Packet;
 617 };
 618
 619 /** An input format supported by the library */
 620 class SR_API InputFormat :
 621         public StructureWrapper<Context, struct sr_input_format>
 622 {
 623 public:
 624         /** Name of this input format. */
 625         string get_name();
 626         /** Description of this input format. */
 627         string get_description();
 628         /** Check whether a given file matches this input format. */
 629         bool format_match(string filename);
 630         /** Open a file using this input format. */
 631         shared_ptr<InputFileDevice> open_file(string filename,
 632                 map<string, string> options = {});
 633 protected:
 634         InputFormat(struct sr_input_format *structure);
 635         ~InputFormat();
 636         friend class Context;
 637         friend class InputFileDevice;
 638 };
 639
 640 /** A virtual device associated with an input file */
 641 class SR_API InputFileDevice : public Device
 642 {
 643 public:
 644         /** Load data from file. */
 645         void load();
 646 protected:
 647         InputFileDevice(shared_ptr<InputFormat> format,
 648                 struct sr_input *input, string filename);
 649         ~InputFileDevice();
 650         struct sr_input *input;
 651         shared_ptr<InputFormat> format;
 652         string filename;
 653         /** Deleter needed to allow shared_ptr use with protected destructor. */
 654         class Deleter
 655         {
 656         public:
 657                 void operator()(InputFileDevice *device) { delete device; }
 658         };
 659         friend class Deleter;
 660         friend class InputFormat;
 661 };
 662
 663 /** An output format supported by the library */
 664 class SR_API OutputFormat :
 665         public StructureWrapper<Context, struct sr_output_format>
 666 {
 667 public:
 668         /** Name of this output format. */
 669         string get_name();
 670         /** Description of this output format. */
 671         string get_description();
 672         /** Create an output using this format. */
 673         shared_ptr<Output> create_output(shared_ptr<Device> device, map<string, string> options = {});
 674 protected:
 675         OutputFormat(struct sr_output_format *structure);
 676         ~OutputFormat();
 677         friend class Context;
 678         friend class Output;
 679 };
 680
 681 /** An output instance (an output format applied to a device) */
 682 class SR_API Output
 683 {
 684 public:
 685         /** Update output with data from the given packet. */
 686         string receive(shared_ptr<Packet> packet);
 687 protected:
 688         Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device);
 689         Output(shared_ptr<OutputFormat> format,
 690                 shared_ptr<Device> device, map<string, string> options);
 691         ~Output();
 692         struct sr_output *structure;
 693         const shared_ptr<OutputFormat> format;
 694         const shared_ptr<Device> device;
 695         const map<string, string> options;
 696         /** Deleter needed to allow shared_ptr use with protected destructor. */
 697         class Deleter
 698         {
 699         public:
 700                 void operator()(Output *output) { delete output; }
 701         };
 702         friend class Deleter;
 703         friend class OutputFormat;
 704 };
 705
 706 /** Base class for objects which wrap an enumeration value from libsigrok */
 707 template <typename T> class SR_API EnumValue
 708 {
 709 public:
 710         /** The enum constant associated with this value. */
 711         T get_id() const { return id; }
 712         /** The name associated with this value. */
 713         string get_name() const { return name; }
 714 protected:
 715         EnumValue(T id, const char name[]) : id(id), name(name) {}
 716         ~EnumValue() {}
 717         const T id;
 718         const string name;
 719 };
 720
 721 #include "enums.hpp"
 722
 723 }
 724
 725 #endif // LIBSIGROK_HPP