[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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef PULSEVIEW_PV_DEVICES_DEVICE_HPP
#define PULSEVIEW_PV_DEVICES_DEVICE_HPP

#include <memory>
#include <string>

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

namespace pv {

class DeviceManager;

namespace devices {

class Device
{
protected:
	Device();

public:
	virtual ~Device();

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

	std::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 std::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 std::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:
	std::shared_ptr<sigrok::Session> session_;
	std::shared_ptr<sigrok::Device> device_;
};

} // namespace devices
} // namespace pv

#endif // PULSEVIEW_PV_DEVICES_DEVICE_HPP
Commit	Line	Data
da30ecb7 JH	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, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#ifndef PULSEVIEW_PV_DEVICES_DEVICE_HPP
	22	#define PULSEVIEW_PV_DEVICES_DEVICE_HPP
	23
	24	#include <memory>
b485408f	25	#include <string>
da30ecb7 JH	26
da30ecb7 JH	27	namespace sigrok {
b48daed6	28	class ConfigKey;
da30ecb7 JH	29	class Device;
	30	class Session;
	31	} // namespace sigrok
	32
	33	namespace pv {
b485408f JH	34
	35	class DeviceManager;
	36
da30ecb7 JH	37	namespace devices {
	38
	39	class Device
	40	{
	41	protected:
	42	Device();
	43
	44	public:
	45	virtual ~Device();
	46
	47	std::shared_ptr<sigrok::Session> session() const;
	48
	49	std::shared_ptr<sigrok::Device> device() const;
	50
b48daed6 JH	51	template<typename T>
	52	T read_config(const sigrok::ConfigKey *key, const T default_value = 0);
	53
b485408f JH	54	/**
	55	* Builds the full name. It only contains all the fields.
	56	*/
	57	virtual std::string full_name() const = 0;
	58
	59	/**
	60	* Builds the display name. It only contains fields as required.
	61	* @param device_manager a reference to the device manager is needed
	62	* so that other similarly titled devices can be detected.
	63	*/
	64	virtual std::string display_name(
	65	const DeviceManager &device_manager) const = 0;
	66
4d6c6ea3 SA	67	virtual void open() = 0;
	68
	69	virtual void close() = 0;
da30ecb7	70
5237f0c5 JH	71	virtual void start();
5237f0c5 JH	72
da30ecb7 JH	73	virtual void run();
	74
	75	virtual void stop();
	76
	77	protected:
	78	std::shared_ptr<sigrok::Session> session_;
	79	std::shared_ptr<sigrok::Device> device_;
	80	};
	81
	82	} // namespace devices
	83	} // namespace pv
	84
	85	#endif // PULSEVIEW_PV_DEVICES_DEVICE_HPP