Rework decode sample count getters

[pulseview.git] / pv / devices / hardwaredevice.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_HARDWAREDEVICE_HPP
#define PULSEVIEW_PV_DEVICES_HARDWAREDEVICE_HPP

#include "device.hpp"

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

namespace sigrok {
class Context;
class HardwareDevice;
} // sigrok

namespace pv {
namespace devices {

class HardwareDevice final : public Device
{
public:
	HardwareDevice(const shared_ptr<sigrok::Context> &context,
		shared_ptr<sigrok::HardwareDevice> device);

	~HardwareDevice();

	shared_ptr<sigrok::HardwareDevice> hardware_device() const;

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

	/**
	 * 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.
	 */
	string display_name(const DeviceManager &device_manager) const;

	void open();

	void close();

private:
	const shared_ptr<sigrok::Context> context_;
	bool device_open_;
};

} // namespace devices
} // namespace pv

#endif // PULSEVIEW_PV_DEVICES_HARDWAREDEVICE_HPP