Use C++ style comments in main.cpp
[pulseview.git] / pv / logicsignal.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 "signal.h"
22
23 #include <boost/shared_ptr.hpp>
24
25 namespace pv {
26
27 class LogicData;
28
29 class LogicSignal : public Signal
30 {
31 private:
32         static const float Margin;
33         static const float Oversampling;
34
35         static const QColor EdgeColour;
36         static const QColor HighColour;
37         static const QColor LowColour;
38
39         static const QColor LogicSignalColours[10];
40
41 public:
42         LogicSignal(QString name,
43                 boost::shared_ptr<LogicData> data,
44                 int probe_index);
45
46         /**
47          * Paints the signal with a QPainter
48          * @param p the QPainter to paint into.
49          * @param rect the rectangular area to draw the trace into.
50          * @param scale the scale in seconds per pixel.
51          * @param offset the time to show at the left hand edge of
52          *   the view in seconds.
53          **/
54         void paint(QPainter &p, const QRect &rect, double scale, double offset);
55
56 private:
57
58         int paint_caps(QPainter &p, QLineF *const lines,
59                 std::vector< std::pair<int64_t, bool> > &edges,
60                 bool level, double samples_per_pixel, double pixels_offset,
61                 int x_offset, int y_offset);
62
63         /**
64          * Get the colour of the logic signal
65          */
66         QColor get_colour() const;
67
68         /**
69          * When painting into the rectangle, calculate the y
70          * offset of the zero point.
71          **/
72         int get_nominal_offset(const QRect &rect) const;
73
74 private:
75         int _probe_index;
76         boost::shared_ptr<LogicData> _data;
77 };
78
79 } // namespace pv