[pulseview.git] / pv / device / devinst.h

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

#ifndef PULSEVIEW_PV_DEVICE_DEVINST_H
#define PULSEVIEW_PV_DEVICE_DEVINST_H

#include <string>

#include <boost/shared_ptr.hpp>

#include <QObject>

#include <glib.h>

#include <stdint.h>

struct sr_dev_inst;
struct sr_probe;
struct sr_probe_group;

namespace pv {

class SigSession;

namespace device {

class DevInst : public QObject
{
	Q_OBJECT

protected:
	DevInst();

public:
	virtual sr_dev_inst* dev_inst() const = 0;

	virtual void use(SigSession *owner) throw(QString);

	virtual void release();

	SigSession* owner() const;

	virtual std::string format_device_title() const = 0;

	GVariant* get_config(const sr_probe_group *group, int key);

	bool set_config(const sr_probe_group *group, int key, GVariant *data);

	GVariant* list_config(const sr_probe_group *group, int key);

	void enable_probe(const sr_probe *probe, bool enable = true);

	/**
	 * @brief Gets the sample limit from the driver.
	 *
	 * @return The returned sample limit from the driver, or 0 if the
	 * 	sample limit could not be read.
	 */
	uint64_t get_sample_limit();

	virtual bool is_trigger_enabled() const;

public:
	virtual void start();

	virtual void run();

signals:
	void config_changed();

protected:
	SigSession *_owner;
};

} // device
} // pv

#endif // PULSEVIEW_PV_DEVICE_DEVINST_H
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, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#ifndef PULSEVIEW_PV_DEVICE_DEVINST_H
	22	#define PULSEVIEW_PV_DEVICE_DEVINST_H
	23
	24	#include <string>
	25
	26	#include <boost/shared_ptr.hpp>
	27
	28	#include <QObject>
	29
	30	#include <glib.h>
	31
	32	#include <stdint.h>
	33
	34	struct sr_dev_inst;
	35	struct sr_probe;
	36	struct sr_probe_group;
	37
	38	namespace pv {
	39
	40	class SigSession;
	41
	42	namespace device {
	43
	44	class DevInst : public QObject
	45	{
	46	Q_OBJECT
	47
	48	protected:
	49	DevInst();
	50
	51	public:
	52	virtual sr_dev_inst* dev_inst() const = 0;
	53
	54	virtual void use(SigSession *owner) throw(QString);
	55
	56	virtual void release();
	57
	58	SigSession* owner() const;
	59
	60	virtual std::string format_device_title() const = 0;
	61
	62	GVariant* get_config(const sr_probe_group *group, int key);
	63
	64	bool set_config(const sr_probe_group group, int key, GVariant data);
	65
	66	GVariant* list_config(const sr_probe_group *group, int key);
	67
	68	void enable_probe(const sr_probe *probe, bool enable = true);
	69
	70	/**
	71	* @brief Gets the sample limit from the driver.
	72	*
	73	* @return The returned sample limit from the driver, or 0 if the
	74	* sample limit could not be read.
	75	*/
	76	uint64_t get_sample_limit();
	77
	78	virtual bool is_trigger_enabled() const;
	79
	80	public:
	81	virtual void start();
	82
	83	virtual void run();
	84
	85	signals:
	86	void config_changed();
	87
	88	protected:
	89	SigSession *_owner;
	90	};
	91
	92	} // device
	93	} // pv
	94
	95	#endif // PULSEVIEW_PV_DEVICE_DEVINST_H