[pulseview.git] / pv / devices / device.hpp

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

#include <memory>
#include <string>

using std::shared_ptr;
using std::string;

namespace sigrok {
class ConfigKey;
class Device;
class Session;
} // namespace sigrok

namespace pv {

class DeviceManager;

namespace devices {

class Device
{
protected:
	Device() = default;

public:
	virtual ~Device();

	shared_ptr<sigrok::Session> session() const;

	shared_ptr<sigrok::Device> device() const;

	template<typename T>
	T read_config(const sigrok::ConfigKey *key, const T default_value = 0);

	/**
	 * Builds the full name. It only contains all the fields.
	 */
	virtual string full_name() const = 0;

	/**
	 * Builds the display name. It only contains fields as required.
	 * @param device_manager a reference to the device manager is needed
	 * so that other similarly titled devices can be detected.
	 */
	virtual string display_name(
		const DeviceManager &device_manager) const = 0;

	virtual void open() = 0;

	virtual void close() = 0;

	virtual void start();

	virtual void run();

	virtual void stop();

protected:
	shared_ptr<sigrok::Session> session_;
	shared_ptr<sigrok::Device> device_;
};

} // namespace devices
} // namespace pv

#endif // PULSEVIEW_PV_DEVICES_DEVICE_HPP
Commit	Line	Data
	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2015 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_DEVICES_DEVICE_HPP
	21	#define PULSEVIEW_PV_DEVICES_DEVICE_HPP
	22
	23	#include <memory>
	24	#include <string>
	25
	26	using std::shared_ptr;
	27	using std::string;
	28
	29	namespace sigrok {
	30	class ConfigKey;
	31	class Device;
	32	class Session;
	33	} // namespace sigrok
	34
	35	namespace pv {
	36
	37	class DeviceManager;
	38
	39	namespace devices {
	40
	41	class Device
	42	{
	43	protected:
	44	Device() = default;
	45
	46	public:
	47	virtual ~Device();
	48
	49	shared_ptr<sigrok::Session> session() const;
	50
	51	shared_ptr<sigrok::Device> device() const;
	52
	53	template<typename T>
	54	T read_config(const sigrok::ConfigKey *key, const T default_value = 0);
	55
	56	/**
	57	* Builds the full name. It only contains all the fields.
	58	*/
	59	virtual string full_name() const = 0;
	60
	61	/**
	62	* Builds the display name. It only contains fields as required.
	63	* @param device_manager a reference to the device manager is needed
	64	* so that other similarly titled devices can be detected.
	65	*/
	66	virtual string display_name(
	67	const DeviceManager &device_manager) const = 0;
	68
	69	virtual void open() = 0;
	70
	71	virtual void close() = 0;
	72
	73	virtual void start();
	74
	75	virtual void run();
	76
	77	virtual void stop();
	78
	79	protected:
	80	shared_ptr<sigrok::Session> session_;
	81	shared_ptr<sigrok::Device> device_;
	82	};
	83
	84	} // namespace devices
	85	} // namespace pv
	86
	87	#endif // PULSEVIEW_PV_DEVICES_DEVICE_HPP