[pulseview.git] / pv / data / decode / decoder.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_DECODER_HPP
#define PULSEVIEW_PV_DATA_DECODE_DECODER_HPP

#include <map>
#include <memory>
#include <set>

#include <glib.h>

using std::map;
using std::set;
using std::shared_ptr;
using std::string;

struct srd_decoder;
struct srd_decoder_inst;
struct srd_channel;
struct srd_session;

namespace pv {

namespace data {

class Logic;
class SignalBase;

namespace decode {

class Decoder
{
public:
	Decoder(const srd_decoder *const dec);

	virtual ~Decoder();

	const srd_decoder* decoder() const;

	bool shown() const;
	void show(bool show = true);

	const map<const srd_channel*,
		shared_ptr<data::SignalBase> >& channels() const;
	void set_channels(map<const srd_channel*,
		shared_ptr<data::SignalBase> > channels);

	void set_initial_pins(GArray *initial_pins);

	GArray *initial_pins() const;

	const map<string, GVariant*>& options() const;

	void set_option(const char *id, GVariant *value);

	bool have_required_channels() const;

	srd_decoder_inst* create_decoder_inst(srd_session *session) const;

	set< shared_ptr<pv::data::Logic> > get_data();

private:
	const srd_decoder *const decoder_;

	bool shown_;

	map<const srd_channel*, shared_ptr<pv::data::SignalBase> > channels_;
	GArray *initial_pins_;
	map<string, GVariant*> options_;
};

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

#endif // PULSEVIEW_PV_DATA_DECODE_DECODER_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_DECODER_HPP
	21	#define PULSEVIEW_PV_DATA_DECODE_DECODER_HPP
	22
	23	#include <map>
	24	#include <memory>
	25	#include <set>
	26
	27	#include <glib.h>
	28
	29	using std::map;
	30	using std::set;
	31	using std::shared_ptr;
	32	using std::string;
	33
	34	struct srd_decoder;
	35	struct srd_decoder_inst;
	36	struct srd_channel;
	37	struct srd_session;
	38
	39	namespace pv {
	40
	41	namespace data {
	42
	43	class Logic;
	44	class SignalBase;
	45
	46	namespace decode {
	47
	48	class Decoder
	49	{
	50	public:
	51	Decoder(const srd_decoder *const dec);
	52
	53	virtual ~Decoder();
	54
	55	const srd_decoder* decoder() const;
	56
	57	bool shown() const;
	58	void show(bool show = true);
	59
	60	const map<const srd_channel*,
	61	shared_ptr<data::SignalBase> >& channels() const;
	62	void set_channels(map<const srd_channel*,
	63	shared_ptr<data::SignalBase> > channels);
	64
	65	void set_initial_pins(GArray *initial_pins);
	66
	67	GArray *initial_pins() const;
	68
	69	const map<string, GVariant*>& options() const;
	70
	71	void set_option(const char id, GVariant value);
	72
	73	bool have_required_channels() const;
	74
	75	srd_decoder_inst* create_decoder_inst(srd_session *session) const;
	76
	77	set< shared_ptr<pv::data::Logic> > get_data();
	78
	79	private:
	80	const srd_decoder *const decoder_;
	81
	82	bool shown_;
	83
	84	map<const srd_channel*, shared_ptr<pv::data::SignalBase> > channels_;
	85	GArray *initial_pins_;
	86	map<string, GVariant*> options_;
	87	};
	88
	89	} // namespace decode
	90	} // namespace data
	91	} // namespace pv
	92
	93	#endif // PULSEVIEW_PV_DATA_DECODE_DECODER_HPP