abstractAddInDockWidget.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 ABSTRACTADDINDOCKWIDGET_H
#define ABSTRACTADDINDOCKWIDGET_H

#include "retVal.h"
#include "typeDefs.h"
#include "sharedStructuresQt.h"
#include "commonGlobal.h"

#include <QtWidgets/qwidget.h>
#include <qmap.h>
#include <qsharedpointer.h>

//forward declarations
namespace ito
{
    class AddInBase; //forward declaration
    class AbstractAddInDockWidgetPrivate; //forward declaration

    //----------------------------------------------------------------------------------------------------------------------------------
    class ITOMCOMMONQT_EXPORT AbstractAddInDockWidget : public QWidget
    {
        Q_OBJECT

        public:
            AbstractAddInDockWidget(ito::AddInBase *plugin);

            virtual ~AbstractAddInDockWidget();
            
            enum MessageLevel 
            {
                msgLevelNo = 0,          
                msgLevelErrorOnly = 1,   
                msgLevelWarningOnly = 2, 
                msgLevelWarningAndError = msgLevelErrorOnly | msgLevelWarningOnly 
            };
        
        protected:

            ito::RetVal setPluginParameter(QSharedPointer<ito::ParamBase> param, MessageLevel msgLevel = msgLevelWarningAndError) const;


            ito::RetVal setPluginParameters(const QVector<QSharedPointer<ito::ParamBase> > params, MessageLevel msgLevel = msgLevelWarningAndError) const;
            

            ito::RetVal observeInvocation(ItomSharedSemaphore *waitCond, MessageLevel msgLevel) const;


            ito::RetVal setActuatorPosition(QVector<int> axes, QVector<double> positions, bool relNotAbs, MessageLevel msgLevel = msgLevelWarningAndError) const;


            ito::RetVal setActuatorPosition(int axis, double position, bool relNotAbs, MessageLevel msgLevel = msgLevelWarningAndError) const;


            ito::RetVal setActuatorInterrupt() const;


            ito::RetVal requestActuatorStatusAndPositions(bool sendCurrentPos, bool sendTargetPos, MessageLevel msgLevel = msgLevelWarningAndError) const;

        private:
            AbstractAddInDockWidgetPrivate* d; 
        public slots:

            virtual void parametersChanged(QMap<QString, ito::Param> params) = 0;
        

            virtual void identifierChanged(const QString &identifier) = 0;
        

            virtual void actuatorStatusChanged(QVector<int> status, QVector<double> actPosition);


            virtual void targetChanged(QVector<double> targetPositions);
    };
} //end namespace ito

#endif //ABSTRACTADDINDOCKWIDGET_H