SlsDetectorInterface.h

//###########################################################################
// This file is part of LImA, a Library for Image Acquisition
//
// Copyright (C) : 2009-2011
// European Synchrotron Radiation Facility
// BP 220, Grenoble 38043
// FRANCE
//
// This 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 3 of the License, or
// (at your option) any later version.
//
// This software 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 SLSDETECTORINTERFACE_H
#define SLSDETECTORINTERFACE_H

#include "lima/HwInterface.h"
#include "SlsDetectorCamera.h"
#include "SlsDetectorReconstruction.h"

namespace lima
{

namespace SlsDetector
{

class Interface;

/*******************************************************************
 * \class EventCallback
 * \brief Bridge class transfering events from Acq -> HwEventCtrlObj
 *******************************************************************/

class EventCallback : public lima::EventCallback
{
	DEB_CLASS_NAMESPC(DebModCamera, "EventCallback", "SlsDetector");

 public:
	EventCallback(HwEventCtrlObj& ctrl_obj);
	virtual ~EventCallback();

 protected:
	virtual void processEvent(Event *event);

 private:
	HwEventCtrlObj& m_ctrl_obj;
};


/*******************************************************************
 * \class DetInfoCtrlObj
 * \brief Control object providing SlsDetector detector info interface
 *******************************************************************/

class DetInfoCtrlObj : public HwDetInfoCtrlObj
{
	DEB_CLASS_NAMESPC(DebModCamera, "DetInfoCtrlObj", "SlsDetector");

 public:
	DetInfoCtrlObj(Camera& cam);
	virtual ~DetInfoCtrlObj();

	virtual void getMaxImageSize(Size& max_image_size);
	virtual void getDetectorImageSize(Size& det_image_size);

	virtual void getDefImageType(ImageType& def_image_type);
	virtual void getCurrImageType(ImageType& curr_image_type);
	virtual void setCurrImageType(ImageType  curr_image_type);

	virtual void getPixelSize(double& x_size, double& y_size);
	virtual void getDetectorType(std::string& det_type);
	virtual void getDetectorModel(std::string& det_model);

	virtual void registerMaxImageSizeCallback(
					HwMaxImageSizeCallback& cb);
	virtual void unregisterMaxImageSizeCallback(
					HwMaxImageSizeCallback& cb);

 private:
	Camera& m_cam;
};


/*******************************************************************
 * \class SyncCtrlObj
 * \brief Control object providing SlsDetector synchronization interface
 *******************************************************************/

class SyncCtrlObj : public HwSyncCtrlObj
{
	DEB_CLASS_NAMESPC(DebModCamera, "SyncCtrlObj", "SlsDetector");

 public:
	SyncCtrlObj(Camera& cam);
	virtual ~SyncCtrlObj();

	virtual bool checkTrigMode(TrigMode trig_mode);
	virtual void setTrigMode(TrigMode  trig_mode);
	virtual void getTrigMode(TrigMode& trig_mode);

	virtual void setExpTime(double  exp_time);
	virtual void getExpTime(double& exp_time);

	virtual void setLatTime(double  lat_time);
	virtual void getLatTime(double& lat_time);

	virtual void setNbHwFrames(int  nb_frames);
	virtual void getNbHwFrames(int& nb_frames);

	virtual void getValidRanges(ValidRangesType& valid_ranges);

	typedef std::map<TrigMode, Camera::TrigMode> TrigModeMap;
	static TrigModeMap Lima2CamTrigModeMap;

 private:
	class TimeRangesChangedCallback : 
				public SlsDetector::TimeRangesChangedCallback
	{
		DEB_CLASS_NAMESPC(DebModCamera, "TimeRangesChangedCallback", 
				  "SlsDetector::SynCtrlObj");
	public:
		TimeRangesChangedCallback(SyncCtrlObj *sync);
	protected:
		virtual void timeRangesChanged(TimeRanges time_ranges);
	private:
		friend class SyncCtrlObj;
		SyncCtrlObj *m_sync;
	};

	Camera& m_cam;
	TimeRangesChangedCallback m_time_ranges_cb;
};


/*******************************************************************
 * \class EventCtrlObj
 * \brief Control object providing SlsDetector event interface
 *******************************************************************/

class EventCtrlObj : public HwEventCtrlObj
{
	DEB_CLASS_NAMESPC(DebModCamera, "EventCtrlObj", "SlsDetector");

public:
	EventCtrlObj();
	virtual ~EventCtrlObj();
};


/*******************************************************************
 * \class ReconstructionCtrlObj
 * \brief Control object providing SlsDetector reconstruction
 *******************************************************************/

class ReconstructionCtrlObj : public HwReconstructionCtrlObj
{
	DEB_CLASS_NAMESPC(DebModCamera, "ReconstructionCtrlObj", "SlsDetector");

public:
	void setReconstruction(Reconstruction *r);

	virtual LinkTask *getReconstructionTask();

private:
	class Proxy : public Reconstruction::CtrlObjProxy {
		DEB_CLASS_NAMESPC(DebModCamera, "ReconstructionCtrlObj::Proxy",
				  "SlsDetector");
	public:
		typedef ReconstructionCtrlObj Owner;

		Proxy(Owner *owner, Reconstruction *r);

		virtual void reconstructionChange(LinkTask *task);

	private:
		Owner *m_owner;
	};

	AutoPtr<Proxy> m_proxy;
};


/*******************************************************************
 * \class Interface
 * \brief SlsDetector hardware interface
 *******************************************************************/

class Interface : public HwInterface
{
	DEB_CLASS_NAMESPC(DebModCamera, "Interface", "SlsDetector");

 public:
	Interface(Camera& cam);
	Interface(const Interface& o) = delete;
	virtual ~Interface();

	virtual void getCapList(CapList&) const;

	virtual void reset(ResetLevel reset_level);
	virtual void prepareAcq();
	virtual void startAcq();
	virtual void stopAcq();
	virtual void getStatus(StatusType& status);
	virtual int getNbHwAcquiredFrames();

	void resetDefaults();

	void setReconstruction(Reconstruction *r);

 private:
	Camera& m_cam;

	CapList m_cap_list;
	DetInfoCtrlObj m_det_info;
	BufferCtrlObj m_buffer;
	SyncCtrlObj m_sync;
	EventCtrlObj m_event;
	ReconstructionCtrlObj m_reconstruction;

	SlsDetector::EventCallback  m_event_cb;
};




} // namespace SlsDetector

} // namespace lima

#endif // SLSDETECTORINTERFACE_H