[pulseview.git] / pv / data / decode / annotation.hpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2013 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_ANNOTATION_HPP
#define PULSEVIEW_PV_DATA_DECODE_ANNOTATION_HPP

#include <cstdint>
#include <vector>

#include <QColor>
#include <QString>

#include "pv/data/decode/row.hpp"

using std::vector;

struct srd_proto_data;

namespace pv {
namespace data {
namespace decode {

class RowData;

class Annotation
{
public:
	Annotation(uint64_t start_sample, uint64_t end_sample,
		const vector<QString>* texts, uint32_t ann_class_id, const RowData *data);
	Annotation(Annotation&& a);
	Annotation& operator=(Annotation&& a);

	const RowData* row_data() const;
	const Row* row() const;

	uint64_t start_sample() const;
	uint64_t end_sample() const;
	uint64_t length() const;

	uint32_t ann_class_id() const;
	const QString ann_class_name() const;
	const QString ann_class_description() const;

	const vector<QString>* annotations() const;
	const QString longest_annotation() const;

	bool visible() const;

	const QColor color() const;
	const QColor bright_color() const;
	const QColor dark_color() const;

	bool operator<(const Annotation &other) const;

private:
	uint64_t start_sample_;
	uint64_t end_sample_;
	const vector<QString>* texts_;
	uint32_t ann_class_id_;
	const RowData* data_;
};

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

#endif // PULSEVIEW_PV_DATA_DECODE_ANNOTATION_HPP
Commit	Line	Data
	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2013 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, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#ifndef PULSEVIEW_PV_DATA_DECODE_ANNOTATION_HPP
	21	#define PULSEVIEW_PV_DATA_DECODE_ANNOTATION_HPP
	22
	23	#include <cstdint>
	24	#include <vector>
	25
	26	#include <QColor>
	27	#include <QString>
	28
	29	#include "pv/data/decode/row.hpp"
	30
	31	using std::vector;
	32
	33	struct srd_proto_data;
	34
	35	namespace pv {
	36	namespace data {
	37	namespace decode {
	38
	39	class RowData;
	40
	41	class Annotation
	42	{
	43	public:
	44	Annotation(uint64_t start_sample, uint64_t end_sample,
	45	const vector<QString>* texts, uint32_t ann_class_id, const RowData *data);
	46	Annotation(Annotation&& a);
	47	Annotation& operator=(Annotation&& a);
	48
	49	const RowData* row_data() const;
	50	const Row* row() const;
	51
	52	uint64_t start_sample() const;
	53	uint64_t end_sample() const;
	54	uint64_t length() const;
	55
	56	uint32_t ann_class_id() const;
	57	const QString ann_class_name() const;
	58	const QString ann_class_description() const;
	59
	60	const vector<QString>* annotations() const;
	61	const QString longest_annotation() const;
	62
	63	bool visible() const;
	64
	65	const QColor color() const;
	66	const QColor bright_color() const;
	67	const QColor dark_color() const;
	68
	69	bool operator<(const Annotation &other) const;
	70
	71	private:
	72	uint64_t start_sample_;
	73	uint64_t end_sample_;
	74	const vector<QString>* texts_;
	75	uint32_t ann_class_id_;
	76	const RowData* data_;
	77	};
	78
	79	} // namespace decode
	80	} // namespace data
	81	} // namespace pv
	82
	83	#endif // PULSEVIEW_PV_DATA_DECODE_ANNOTATION_HPP