cxFilter.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.
                 
Copyright (c) SINTEF Department of Medical Technology.
All rights reserved.
                 
CustusX is released under a BSD 3-Clause license.
                 
See Lisence.txt (https://github.com/SINTEFMedtek/CustusX/blob/master/License.txt) for details.
=========================================================================*/

#ifndef CXFILTER_H
#define CXFILTER_H

#include "cxResourceFilterExport.h"

#include <vector>
#include <QObject>

#include "cxPresets.h"
#include "cxForwardDeclarations.h"
class QDomElement;

#define FilterService_iid "cx::Filter"

namespace cx
{
typedef boost::shared_ptr<class SelectDataStringPropertyBase> SelectDataStringPropertyBasePtr;

typedef boost::shared_ptr<class Filter> FilterPtr;


class cxResourceFilter_EXPORT Filter : public QObject
{
        Q_OBJECT

public:
    Filter();
        virtual ~Filter() {}

        virtual QString getUid() const  = 0;
        virtual void initialize(QDomElement root, QString uid = "") = 0;
        virtual QString getType() const  = 0;
        virtual QString getName() const = 0;
        virtual QString getHelp() const = 0;
        virtual std::vector<PropertyPtr> getOptions() = 0;
        virtual std::vector<SelectDataStringPropertyBasePtr> getInputTypes() = 0;
        virtual std::vector<SelectDataStringPropertyBasePtr> getOutputTypes() = 0;

        virtual bool hasPresets() = 0;

        virtual PresetsPtr getPresets() = 0;
        virtual QDomElement generatePresetFromCurrentlySetOptions(QString name) = 0;
        virtual void setActive(bool on) = 0;
        virtual bool preProcess() = 0;
        virtual bool execute() = 0;
        virtual bool postProcess() = 0;

public slots:
        virtual void requestSetPresetSlot(QString name) = 0;

signals:
        void changed();

};

} // namespace cx

Q_DECLARE_INTERFACE(cx::Filter, FilterService_iid)

#endif // CXFILTER_H