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

/*
 * 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_ROWDATA_HPP
#define PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP

#include <unordered_map>
#include <vector>

#include <QHash>
#include <QString>

#include <libsigrokdecode/libsigrokdecode.h>

#include <pv/data/decode/annotation.hpp>

using std::deque;
using std::unordered_map;

namespace std {
  template<> struct hash<QString> {
    std::size_t operator()(const QString& s) const noexcept {
      return (size_t) qHash(s);
    }
  };
}

namespace pv {
namespace data {
namespace decode {

class Row;

class RowData
{
public:
	RowData(Row* row);

	const Row* row() const;

	uint64_t get_max_sample() const;

	uint64_t get_annotation_count() const;

	/**
	 * Extracts annotations between the given sample range into a vector.
	 * Note: The annotations are unsorted and only annotations that fully
	 * fit into the sample range are considered.
	 */
	void get_annotation_subset(deque<const pv::data::decode::Annotation*> &dest,
		uint64_t start_sample, uint64_t end_sample) const;

	const deque<Annotation>& annotations() const;

	const Annotation* emplace_annotation(srd_proto_data *pdata);

private:
	deque<Annotation> annotations_;
	unordered_map<QString, vector<QString> > ann_texts_;  // unordered_map since pointers must not change
	Row* row_;
	uint64_t prev_ann_start_sample_;
};

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

#endif // PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP
Commit	Line	Data
	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2014 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_ROWDATA_HPP
	21	#define PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP
	22
	23	#include <unordered_map>
	24	#include <vector>
	25
	26	#include <QHash>
	27	#include <QString>
	28
	29	#include <libsigrokdecode/libsigrokdecode.h>
	30
	31	#include <pv/data/decode/annotation.hpp>
	32
	33	using std::deque;
	34	using std::unordered_map;
	35
	36	namespace std {
	37	template<> struct hash<QString> {
	38	std::size_t operator()(const QString& s) const noexcept {
	39	return (size_t) qHash(s);
	40	}
	41	};
	42	}
	43
	44	namespace pv {
	45	namespace data {
	46	namespace decode {
	47
	48	class Row;
	49
	50	class RowData
	51	{
	52	public:
	53	RowData(Row* row);
	54
	55	const Row* row() const;
	56
	57	uint64_t get_max_sample() const;
	58
	59	uint64_t get_annotation_count() const;
	60
	61	/**
	62	* Extracts annotations between the given sample range into a vector.
	63	* Note: The annotations are unsorted and only annotations that fully
	64	* fit into the sample range are considered.
	65	*/
	66	void get_annotation_subset(deque<const pv::data::decode::Annotation*> &dest,
	67	uint64_t start_sample, uint64_t end_sample) const;
	68
	69	const deque<Annotation>& annotations() const;
	70
	71	const Annotation* emplace_annotation(srd_proto_data *pdata);
	72
	73	private:
	74	deque<Annotation> annotations_;
	75	unordered_map<QString, vector<QString> > ann_texts_; // unordered_map since pointers must not change
	76	Row* row_;
	77	uint64_t prev_ann_start_sample_;
	78	};
	79
	80	} // namespace decode
	81	} // namespace data
	82	} // namespace pv
	83
	84	#endif // PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP