pv/signal.h

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   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 2 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <boost/shared_ptr.hpp>
  22
  23 #include <QPainter>
  24 #include <QRect>
  25 #include <QString>
  26
  27 #include <stdint.h>
  28
  29 namespace pv {
  30
  31 class SignalData;
  32
  33 class Signal
  34 {
  35 private:
  36         static const QSizeF LabelPadding;
  37
  38 protected:
  39         Signal(QString name);
  40
  41 public:
  42         QString get_name() const;
  43
  44         /**
  45          * Paints the signal with a QPainter
  46          * @param p the QPainter to paint into.
  47          * @param rect the rectangular area to draw the trace into.
  48          * @param scale the scale in seconds per pixel.
  49          * @param offset the time to show at the left hand edge of
  50          *   the view in seconds.
  51          **/
  52         virtual void paint(QPainter &p, const QRect &rect, double scale,
  53                 double offset) = 0;
  54
  55         /**
  56          * Computes the outline rectangle of a label.
  57          * @param p the QPainter to lay out text with.
  58          * @param rect The rectangle of the signal header.
  59          * @return Returns the rectangle of the signal label.
  60          */
  61         virtual QRectF get_label_rect(QPainter &p, const QRect &rect);
  62
  63         /**
  64          * Paints the signal label into a QGLWidget.
  65          * @param p the QPainter to paint into.
  66          * @param rect the rectangular area to draw the label into.
  67          */
  68         virtual void paint_label(QPainter &p, const QRect &rect);
  69
  70 protected:
  71
  72         /**
  73          * Get the colour of the logic signal
  74          */
  75         virtual QColor get_colour() const = 0;
  76
  77         /**
  78          * When painting into the rectangle, calculate the y
  79          * offset of the zero point.
  80          **/
  81         virtual int get_nominal_offset(const QRect &rect) const = 0;
  82
  83 protected:
  84         QString _name;
  85 };
  86
  87 } // namespace pv