View: Move comment to where it belongs

[pulseview.git] / pv / views / trace / signal.hpp

diff --git a/pv/views/trace/signal.hpp b/pv/views/trace/signal.hpp
index d763609d972abc322dc796e9aca32a2add66269f..2cc49a77d1962499c8bece819c5a0824485bf543 100644 (file)
--- a/pv/views/trace/signal.hpp
+++ b/pv/views/trace/signal.hpp
@@ -44,6 +44,15 @@ class SignalData;
 namespace views {
 namespace trace {
 
+/**
+ * The Signal class represents a series of numeric values that can be drawn.
+ * This is the main difference to the more generic @ref Trace class.
+ *
+ * It is generally accepted that Signal instances consider themselves to be
+ * individual channels on e.g. an oscilloscope, though it should be kept in
+ * mind that virtual signals (e.g. math) will also be served by the Signal
+ * class.
+ */
 class Signal : public Trace, public ViewItemOwner
 {
        Q_OBJECT
@@ -66,6 +75,10 @@ public:
 
        shared_ptr<data::SignalBase> base() const;
 
+       void set_current_segment(const int segment);
+
+       int get_current_segment() const;
+
        virtual void save_settings(QSettings &settings) const;
 
        virtual void restore_settings(QSettings &settings);
@@ -89,6 +102,9 @@ protected:
        pv::Session &session_;
 
        QComboBox *name_widget_;
+
+       /// The ID of the currently displayed segment
+       int current_segment_;
 };
 
 } // namespace trace