pluginThreadCtrl.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2020, Institut fuer Technische Optik (ITO),
    Universitaet Stuttgart, Germany

    This file is part of itom and its software development toolkit (SDK).

    itom is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public Licence as published by
    the Free Software Foundation; either version 2 of the Licence, or (at
    your option) any later version.
   
    In addition, as a special exception, the Institut fuer Technische
    Optik (ITO) gives you certain additional rights.
    These rights are described in the ITO LGPL Exception version 1.0,
    which can be found in the file LGPL_EXCEPTION.txt in this package.

    itom 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 Library
    General Public Licence for more details.

    You should have received a copy of the GNU Library General Public License
    along with itom. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************** */

#ifndef PLUGINTHREADCTRL_H
#define PLUGINTHREADCTRL_H

#include "typeDefs.h"
#include "addInInterface.h"
#include "sharedStructures.h"

#if !defined(Q_MOC_RUN) || defined(ITOMCOMMONQT_MOC) //only moc this file in itomCommonQtLib but not in other libraries or executables linking against this itomCommonQtLib

namespace ito
{

//----------------------------------------------------------------------------------------------------------------------------------
class ITOMCOMMONQT_EXPORT PluginThreadCtrl
{
protected:
    ito::AddInBase *m_pPlugin;                   
    ItomSharedSemaphoreLocker m_semaphoreLocker; 
public:
    PluginThreadCtrl();


    PluginThreadCtrl(const ito::ParamBase &pluginParameter, ito::RetVal *retval = NULL);


    PluginThreadCtrl(ito::AddInBase *plugin, ito::RetVal *retval = NULL);

    PluginThreadCtrl(const PluginThreadCtrl &other);

    virtual ~PluginThreadCtrl();

    PluginThreadCtrl& operator =(const PluginThreadCtrl &other);

    ito::RetVal getParam(ito::Param &val, int timeOutMS = PLUGINWAIT);      
    ito::RetVal setParam(ito::ParamBase val, int timeOutMS = PLUGINWAIT);   
    ito::RetVal waitForSemaphore(int timeOutMS = PLUGINWAIT);               
};


//-----------------------------------------------------------------------------------
class ITOMCOMMONQT_EXPORT DataIOThreadCtrl : public PluginThreadCtrl
{
public:
    DataIOThreadCtrl();


    DataIOThreadCtrl(const ito::ParamBase &pluginParameter, ito::RetVal *retval = NULL);


    DataIOThreadCtrl(ito::AddInDataIO *plugin, ito::RetVal *retval = NULL);

    DataIOThreadCtrl(const DataIOThreadCtrl &other);

    virtual ~DataIOThreadCtrl();

    ito::RetVal startDevice(int timeOutMS = PLUGINWAIT);                     
    ito::RetVal stopDevice(int timeOutMS = PLUGINWAIT);                      
    ito::RetVal acquire(const int trigger = 0, int timeOutMS = PLUGINWAIT);  
    ito::RetVal getVal(ito::DataObject &dObj, int timeOutMS = PLUGINWAIT);   
    ito::RetVal copyVal(ito::DataObject &dObj, int timeOutMS = PLUGINWAIT);  
    ito::RetVal enableAutoGrabbing(int timeOutMS = PLUGINWAIT);              
    ito::RetVal disableAutoGrabbing(int timeOutMS = PLUGINWAIT);             
    ito::RetVal setAutoGrabbingInterval(QSharedPointer<int> interval, int timeOutMS = PLUGINWAIT); 
    bool getAutoGrabbing();                                                  
    ito::RetVal getImageParams(int &bpp, int &sizex, int &sizey, int timeOutMS = PLUGINWAIT); 
};

//-----------------------------------------------------------------------------------
class ITOMCOMMONQT_EXPORT ActuatorThreadCtrl : public PluginThreadCtrl
{
protected:
    int m_numAxes;

public:
    ActuatorThreadCtrl();            


    ActuatorThreadCtrl(const ito::ParamBase &pluginParameter, ito::RetVal *retval = NULL);


    ActuatorThreadCtrl(ito::AddInActuator *plugin, ito::RetVal *retval = NULL);

    ActuatorThreadCtrl(const ActuatorThreadCtrl &other);

    virtual ~ActuatorThreadCtrl();

    ito::RetVal setPosRel(const QVector<int> &axes, const QVector<double> &relPositions, int timeOutMS = PLUGINWAIT);  
    ito::RetVal setPosAbs(const QVector<int> &axes, const QVector<double> &absPositions, int timeOutMS = PLUGINWAIT);  
    ito::RetVal setPosRel(int axis, double relPosition, int timeOutMS = PLUGINWAIT);                       
    ito::RetVal setPosAbs(int axis, double absPosition, int timeOutMS = PLUGINWAIT);                       
    ito::RetVal getPos(QVector<int> axes, QVector<double> &positions, int timeOutMS = PLUGINWAIT);         
    ito::RetVal getPos(int axis, double &position, int timeOutMS = PLUGINWAIT);                            
    ito::RetVal checkAxis(int axisNum);                                                              
};

}   // end namespace ito

#endif //#if !defined(Q_MOC_RUN) || defined(ITOMCOMMONQT_MOC)
#endif //PLUGINTHREADCTRL_H