Bindings: Provide helper method that auto-converts analog

[libsigrok.git] / bindings / cxx / include / libsigrokcxx / libsigrokcxx.hpp

diff --git a/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp b/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp
index d8cf3bdc3f62b449e18bf58ad25968ea8f096ffa..b1ab7a5bd6f6e04a06607c80017e8fc0d9473f73 100644 (file)
--- a/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp
+++ b/bindings/cxx/include/libsigrokcxx/libsigrokcxx.hpp
@@ -98,6 +98,7 @@ class SR_API HardwareDevice;
 class SR_API Channel;
 class SR_API Session;
 class SR_API ConfigKey;
+class SR_API Capability;
 class SR_API InputFormat;
 class SR_API OutputFormat;
 class SR_API OutputFlag;
@@ -114,6 +115,7 @@ class SR_API PacketType;
 class SR_API Quantity;
 class SR_API Unit;
 class SR_API QuantityFlag;
+class SR_API Rational;
 class SR_API Input;
 class SR_API InputDevice;
 class SR_API Output;
@@ -231,7 +233,7 @@ private:
                        const char *name, void *cb_data) noexcept;
        static SR_PRIV int close_callback(struct sr_resource *res,
                        void *cb_data) noexcept;
-       static SR_PRIV ssize_t read_callback(const struct sr_resource *res,
+       static SR_PRIV gssize read_callback(const struct sr_resource *res,
                        void *buf, size_t count, void *cb_data) noexcept;
        friend class Context;
 };
@@ -310,16 +312,12 @@ private:
        friend struct std::default_delete<Context>;
 };
 
-enum Capability {
-       GET = SR_CONF_GET,
-       SET = SR_CONF_SET,
-       LIST = SR_CONF_LIST
-};
-
 /** An object that can be configured. */
 class SR_API Configurable
 {
 public:
+       /** Supported configuration keys. */
+       set<const ConfigKey *> config_keys() const;
        /** Read configuration for the given key.
         * @param key ConfigKey to read. */
        Glib::VariantBase config_get(const ConfigKey *key) const;
@@ -330,10 +328,13 @@ public:
        /** Enumerate available values for the given configuration key.
         * @param key ConfigKey to enumerate values for. */
        Glib::VariantContainerBase config_list(const ConfigKey *key) const;
-       /** Enumerate available keys, according to a given index key. */
-       map<const ConfigKey *, set<enum Capability> > config_keys(const ConfigKey *key);
-       /** Check for a key in the list from a given index key. */
-       bool config_check(const ConfigKey *key, const ConfigKey *index_key) const;
+       /** Enumerate configuration capabilities for the given configuration key.
+        * @param key ConfigKey to enumerate capabilities for. */
+       set<const Capability *> config_capabilities(const ConfigKey *key) const;
+       /** Check whether a configuration capability is supported for a given key.
+        * @param key ConfigKey to check.
+     * @param capability Capability to check for. */
+       bool config_check(const ConfigKey *key, const Capability *capability) const;
 protected:
        Configurable(
                struct sr_dev_driver *driver,
@@ -346,15 +347,15 @@ protected:
 };
 
 /** A hardware driver provided by the library */
-class SR_API Driver :
-       public ParentOwned<Driver, Context>,
-       public Configurable
+class SR_API Driver : public ParentOwned<Driver, Context>, public Configurable
 {
 public:
        /** Name of this driver. */
        string name() const;
        /** Long name for this driver. */
        string long_name() const;
+       /** Scan options supported by this driver. */
+       set<const ConfigKey *> scan_options() const;
        /** Scan for devices and return a list of devices found.
         * @param options Mapping of (ConfigKey, value) pairs. */
        vector<shared_ptr<HardwareDevice> > scan(map<const ConfigKey *, Glib::VariantBase>
@@ -767,10 +768,35 @@ class SR_API Analog :
 public:
        /** Pointer to data. */
        void *data_pointer();
+       /**
+        * Fills dest pointer with the analog data converted to float.
+        * The pointer must have space for num_samples() floats.
+        */
+       void get_data_as_float(float *dest);
        /** Number of samples in this packet. */
        unsigned int num_samples() const;
        /** Channels for which this packet contains data. */
        vector<shared_ptr<Channel> > channels();
+       /** Size of a single sample in bytes. */
+       unsigned int unitsize() const;
+       /** Samples use a signed data type. */
+       bool is_signed() const;
+       /** Samples use float. */
+       bool is_float() const;
+       /** Samples are stored in big-endian order. */
+       bool is_bigendian() const;
+       /**
+        * Number of significant digits after the decimal point if positive,
+        * or number of non-significant digits before the decimal point if negative
+        * (refers to the value we actually read on the wire).
+        */
+       int digits() const;
+       /** TBD */
+       bool is_digits_decimal() const;
+       /** TBD */
+       shared_ptr<Rational> scale();
+       /** TBD */
+       shared_ptr<Rational> offset();
        /** Measured quantity of the samples in this packet. */
        const Quantity *mq() const;
        /** Unit of the samples in this packet. */
@@ -787,6 +813,28 @@ private:
        friend class Packet;
 };
 
+/** Number represented by a numerator/denominator integer pair */
+class SR_API Rational :
+       public ParentOwned<Rational, Analog>
+{
+public:
+       /** Numerator, i.e. the dividend. */
+       int64_t numerator() const;
+       /** Denominator, i.e. the divider. */
+       uint64_t denominator() const;
+       /** Actual (lossy) value. */
+       float value() const;
+private:
+       explicit Rational(const struct sr_rational *structure);
+       ~Rational();
+       shared_ptr<Rational> share_owned_by(shared_ptr<Analog> parent);
+
+       const struct sr_rational *_structure;
+
+       friend class Analog;
+       friend struct std::default_delete<Rational>;
+};
+
 /** An input format supported by the library */
 class SR_API InputFormat :
        public ParentOwned<InputFormat, Context>
@@ -828,6 +876,7 @@ public:
        void send(void *data, size_t length);
        /** Signal end of input data. */
        void end();
+       void reset();
 private:
        Input(shared_ptr<Context> context, const struct sr_input *structure);
        ~Input();