Use nullptr in a few places.
[pulseview.git] / pv / data / signalbase.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5  * Copyright (C) 2016 Soeren Apel <soeren@apelpie.net>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef PULSEVIEW_PV_DATA_SIGNALBASE_HPP
22 #define PULSEVIEW_PV_DATA_SIGNALBASE_HPP
23
24 #include <QColor>
25 #include <QObject>
26 #include <QSettings>
27 #include <QString>
28
29 #include <libsigrokcxx/libsigrokcxx.hpp>
30
31
32 namespace sigrok {
33 class Channel;
34 class ChannelType;
35 }
36
37 namespace pv {
38 namespace data {
39
40 class Analog;
41 class DecoderStack;
42 class Logic;
43 class SignalData;
44
45 class SignalBase : public QObject
46 {
47         Q_OBJECT
48
49 private:
50         static const int ColourBGAlpha;
51
52 public:
53         SignalBase(std::shared_ptr<sigrok::Channel> channel);
54         virtual ~SignalBase() {}
55
56 public:
57         /**
58          * Returns the underlying SR channel.
59          */
60         std::shared_ptr<sigrok::Channel> channel() const;
61
62         /**
63          * Returns enabled status of this channel.
64          */
65         bool enabled() const;
66
67         /**
68          * Sets the enabled status of this channel.
69          * @param value Boolean value to set.
70          */
71         void set_enabled(bool value);
72
73         /**
74          * Gets the type of this channel.
75          */
76         const sigrok::ChannelType *type() const;
77
78         /**
79          * Gets the index number of this channel.
80          */
81         unsigned int index() const;
82
83         /**
84          * Gets the name of this signal.
85          */
86         QString name() const;
87
88         /**
89          * Gets the internal name of this signal, i.e. how the device calls it.
90          */
91         QString internal_name() const;
92
93         /**
94          * Sets the name of the signal.
95          */
96         virtual void set_name(QString name);
97
98         /**
99          * Get the colour of the signal.
100          */
101         QColor colour() const;
102
103         /**
104          * Set the colour of the signal.
105          */
106         void set_colour(QColor colour);
107
108         /**
109          * Get the background colour of the signal.
110          */
111         QColor bgcolour() const;
112
113         /**
114          * Sets the internal data object.
115          */
116         void set_data(std::shared_ptr<pv::data::SignalData> data);
117
118         /**
119          * Get the internal data as analog data object in case of analog type.
120          */
121         std::shared_ptr<pv::data::Analog> analog_data() const;
122
123         /**
124          * Get the internal data as logic data object in case of logic type.
125          */
126         std::shared_ptr<pv::data::Logic> logic_data() const;
127
128 #ifdef ENABLE_DECODE
129         bool is_decode_signal() const;
130
131         std::shared_ptr<pv::data::DecoderStack> decoder_stack() const;
132
133         void set_decoder_stack(std::shared_ptr<pv::data::DecoderStack>
134                 decoder_stack);
135 #endif
136
137         void save_settings(QSettings &settings) const;
138
139         void restore_settings(QSettings &settings);
140
141 Q_SIGNALS:
142         void enabled_changed(const bool &value);
143
144         void name_changed(const QString &name);
145
146         void colour_changed(const QColor &colour);
147
148 private:
149         std::shared_ptr<sigrok::Channel> channel_;
150         std::shared_ptr<pv::data::SignalData> data_;
151
152 #ifdef ENABLE_DECODE
153         std::shared_ptr<pv::data::DecoderStack> decoder_stack_;
154 #endif
155
156         QString internal_name_, name_;
157         QColor colour_, bgcolour_;
158 };
159
160 } // namespace data
161 } // namespace pv
162
163 #endif // PULSEVIEW_PV_DATA_SIGNALBASE_HPP