row.hpp

Go to the documentation of this file.

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2014 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef PULSEVIEW_PV_DATA_DECODE_ROW_HPP
#define PULSEVIEW_PV_DATA_DECODE_ROW_HPP

#include <map>
#include <vector>

#include <QObject>
#include <QColor>

struct srd_decoder;
struct srd_decoder_annotation_row;

using std::map;
using std::vector;

namespace pv {
namespace data {
namespace decode {

#define DECODE_COLOR_SATURATION (180) /* 0-255 */
#define DECODE_COLOR_VALUE (170) /* 0-255 */

class AnnotationClass;
class Decoder;

class Row: public QObject
{
    Q_OBJECT

public:
    Row();

    Row(uint32_t index, Decoder* decoder,
        const srd_decoder_annotation_row* srd_row = nullptr);

    const Decoder* decoder() const;
    const srd_decoder_annotation_row* get_srd_row() const;

    const QString title() const;
    const QString description() const;
    vector<AnnotationClass*> ann_classes() const;
    uint32_t index() const;

    bool visible() const;
    void set_visible(bool visible);

    void set_base_color(QColor base_color);
    const QColor color() const;
    const QColor get_class_color(uint32_t ann_class_id) const;
    const QColor get_bright_class_color(uint32_t ann_class_id) const;
    const QColor get_dark_class_color(uint32_t ann_class_id) const;

    bool has_hidden_classes() const;
    bool class_is_visible(uint32_t ann_class_id) const;

    bool operator<(const Row& other) const;
    bool operator==(const Row& other) const;

Q_SIGNALS:
    void visibility_changed();

private:
    uint32_t index_;
    Decoder* decoder_;
    const srd_decoder_annotation_row* srd_row_;
    bool visible_;

    QColor color_;
    map<uint32_t, QColor> ann_class_color_;
    map<uint32_t, QColor> ann_bright_class_color_;
    map<uint32_t, QColor> ann_dark_class_color_;
};

}  // namespace decode
}  // namespace data
}  // namespace pv

#endif // PULSEVIEW_PV_DATA_DECODE_ROW_HPP