addInGrabber.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 ADDINGRABBER_H
#define ADDINGRABBER_H

#include "addInInterface.h"

#include "../DataObject/dataobj.h"
#include "sharedStructuresQt.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 AddInGrabberPrivate;

    class ITOMCOMMONQT_EXPORT AddInGrabber : public ito::AddInDataIO
    {
        Q_OBJECT

    private:

        int m_started;

        AddInGrabberPrivate *dd;        

    protected:
        void timerEvent (QTimerEvent *event);  

        virtual ito::RetVal checkData(ito::DataObject *externalDataObject = NULL);


        virtual ito::RetVal retrieveData(ito::DataObject *externalDataObject = NULL) = 0; 

        ito::RetVal sendDataToListeners(int waitMS);  
        inline int grabberStartedCount() { return m_started; }  
        inline void incGrabberStarted() 
        { 
            m_started++; 
            if(m_started == 1)
            {
                runStatusChanged(true); //now, the device is started -> check if any listener is connected and if so start the auto grabbing timer (if flag is true, too)
            }
        }  

        inline void decGrabberStarted() 
        { 
            m_started--; 
            if(m_started == 0)
            {
                runStatusChanged(false); //now, the device is stopped -> stop any possibly started auto grabbing listener
            }
        } 

        inline void setGrabberStarted(int value) 
        { 
            m_started = value; 
            runStatusChanged( value > 0 );
        }  

        ito::DataObject m_data; 
    public:
        AddInGrabber();
        ~AddInGrabber();

    };
} //end namespace ito

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

#endif