Implement MathSignal

[pulseview.git] / pv / data / signalbase.hpp

diff --git a/pv/data/signalbase.hpp b/pv/data/signalbase.hpp
index 3356af5b786ad3fefeace38f7d42fe32dc7bdfa7..5a35218f3a2501e87d5e27ef8656532f27191e74 100644 (file)
--- a/pv/data/signalbase.hpp
+++ b/pv/data/signalbase.hpp
@@ -22,6 +22,7 @@
 #define PULSEVIEW_PV_DATA_SIGNALBASE_HPP
 
 #include <atomic>
+#include <deque>
 #include <condition_variable>
 #include <thread>
 #include <vector>
@@ -35,8 +36,12 @@
 
 #include <libsigrokcxx/libsigrokcxx.hpp>
 
+#include "segment.hpp"
+
 using std::atomic;
 using std::condition_variable;
+using std::deque;
+using std::enable_shared_from_this;
 using std::map;
 using std::mutex;
 using std::pair;
@@ -55,9 +60,31 @@ class AnalogSegment;
 class DecoderStack;
 class Logic;
 class LogicSegment;
+class Segment;
+class SignalBase;
 class SignalData;
 
-class SignalBase : public QObject
+class SignalGroup : public QObject
+{
+       Q_OBJECT
+
+public:
+       SignalGroup(const QString& name);
+
+       void append_signal(shared_ptr<SignalBase> signal);
+       void remove_signal(shared_ptr<SignalBase> signal);
+       deque<shared_ptr<SignalBase>> signals() const;
+       void clear();
+
+       const QString name() const;
+
+private:
+       deque<shared_ptr<SignalBase>> signals_;
+       QString name_;
+};
+
+
+class SignalBase : public QObject, public enable_shared_from_this<SignalBase>
 {
        Q_OBJECT
 
@@ -86,7 +113,7 @@ public:
        };
 
 private:
-       static const int ColourBGAlpha;
+       static const int ColorBGAlpha;
        static const uint64_t ConversionBlockSize;
        static const uint32_t ConversionDelay;
 
@@ -97,9 +124,15 @@ public:
 public:
        /**
         * Returns the underlying SR channel.
+        * Generated channels don't have a SR channel.
         */
        shared_ptr<sigrok::Channel> channel() const;
 
+       /**
+        * Returns whether this channel is generated or a channel associated with the device.
+        */
+       bool is_generated() const;
+
        /**
         * Returns enabled status of this channel.
         */
@@ -122,6 +155,13 @@ public:
         */
        unsigned int index() const;
 
+       /**
+        * Sets the index number of this channel, i.e. a unique ID assigned by
+        * the device driver or the logic bit index (see below).
+        * Only use immediately after creating the signal and leave it untouched after.
+        */
+       void set_index(unsigned int index);
+
        /**
         * Returns which bit of a given sample for this signal represents the
         * signal itself. This is relevant for compound signals like logic,
@@ -130,16 +170,32 @@ public:
         */
        unsigned int logic_bit_index() const;
 
+       /**
+        * Sets the signal group this signal belongs to
+        */
+       void set_group(SignalGroup* group);
+
+       /**
+        * Returns the signal group this signal belongs to or nullptr if none
+        */
+       SignalGroup* group() const;
+
        /**
         * Gets the name of this signal.
         */
        QString name() const;
 
        /**
-        * Gets the internal name of this signal, i.e. how the device calls it.
+        * Gets the internal name of this signal, i.e. how the device/generator calls it.
         */
        QString internal_name() const;
 
+       /**
+        * Sets the internal name of this signal, i.e. how the device/generator calls it.
+        * Only use immediately after creating the signal and leave it untouched after.
+        */
+       void set_internal_name(QString internal_name);
+
        /**
         * Produces a string for this signal that can be used for display,
         * i.e. it contains one or both of the signal/internal names.
@@ -152,25 +208,30 @@ public:
        virtual void set_name(QString name);
 
        /**
-        * Get the colour of the signal.
+        * Get the color of the signal.
         */
-       QColor colour() const;
+       QColor color() const;
 
        /**
-        * Set the colour of the signal.
+        * Set the color of the signal.
         */
-       void set_colour(QColor colour);
+       void set_color(QColor color);
 
        /**
-        * Get the background colour of the signal.
+        * Get the background color of the signal.
         */
-       QColor bgcolour() const;
+       QColor bgcolor() const;
 
        /**
         * Sets the internal data object.
         */
        void set_data(shared_ptr<pv::data::SignalData> data);
 
+       /**
+        * Clears all sample data and removes all associated segments.
+        */
+       void clear_sample_data();
+
        /**
         * Get the internal data as analog data object in case of analog type.
         */
@@ -192,6 +253,11 @@ public:
         */
        bool has_samples() const;
 
+       /**
+        * Returns the sample rate for this signal.
+        */
+       virtual double get_samplerate() const;
+
        /**
         * Queries the kind of conversion performed on this channel.
         */
@@ -273,7 +339,6 @@ public:
 #endif
 
        virtual void save_settings(QSettings &settings) const;
-
        virtual void restore_settings(QSettings &settings);
 
        void start_conversion(bool delayed_start=false);
@@ -298,7 +363,7 @@ Q_SIGNALS:
 
        void name_changed(const QString &name);
 
-       void colour_changed(const QColor &colour);
+       void color_changed(const QColor &color);
 
        void conversion_type_changed(const ConversionType t);
 
@@ -312,7 +377,7 @@ Q_SIGNALS:
 private Q_SLOTS:
        void on_samples_cleared();
 
-       void on_samples_added(QObject* segment, uint64_t start_sample,
+       void on_samples_added(SharedPtrToSegment segment, uint64_t start_sample,
                uint64_t end_sample);
 
        void on_min_max_changed(float min, float max);
@@ -324,6 +389,7 @@ private Q_SLOTS:
 protected:
        shared_ptr<sigrok::Channel> channel_;
        ChannelType channel_type_;
+       SignalGroup* group_;
        shared_ptr<pv::data::SignalData> data_;
        shared_ptr<pv::data::SignalData> converted_data_;
        ConversionType conversion_type_;
@@ -338,7 +404,8 @@ protected:
        QTimer delayed_conversion_starter_;
 
        QString internal_name_, name_;
-       QColor colour_, bgcolour_;
+       QColor color_, bgcolor_;
+       unsigned int index_;
 };
 
 } // namespace data