io/fwDicomIOFilter/include/fwDicomIOFilter/IFilter.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2017.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#ifndef __FWDICOMIOFILTER_IFILTER_HPP__
#define __FWDICOMIOFILTER_IFILTER_HPP__

#include "fwDicomIOFilter/config.hpp"
#include "fwDicomIOFilter/exceptions/FilterFailure.hpp"
#include "fwDicomIOFilter/factory/new.hpp"
#include "fwDicomIOFilter/registry/detail.hpp"

#include <fwLog/Logger.hpp>

#include <fwMedData/DicomSeries.hpp>

#include <fwTools/Object.hpp>

namespace fwDicomIOFilter
{

class FWDICOMIOFILTER_CLASS_API IFilter :   public ::fwTools::Object
{
public:

    typedef ::fwDicomIOFilter::factory::Key Key;

    template <typename T>
    class Registrar
    {
    public:
        Registrar()
        {
            ::fwDicomIOFilter::registry::get()->addFactory(T::classname(), &::fwDicomIOFilter::factory::New<T>);
        }
    };

    fwCoreNonInstanciableClassDefinitionsMacro( (IFilter)(::fwTools::Object) );

    typedef std::vector< ::fwMedData::DicomSeries::sptr > DicomSeriesContainerType;

    typedef enum
    {
        MODIFIER  = 0,  
        SORTER    = 1,  
        SPLITTER  = 2,  
        COMPOSITE = 3,  
        CUSTOM    = 4,  
    } FilterType;

    FWDICOMIOFILTER_API virtual ~IFilter();

    FWDICOMIOFILTER_API virtual DicomSeriesContainerType apply(
        const ::fwMedData::DicomSeries::sptr& series, const ::fwLog::Logger::sptr& logger) const = 0;

    FWDICOMIOFILTER_API virtual std::string getName() const = 0;

    FWDICOMIOFILTER_API virtual std::string getDescription() const = 0;

    FWDICOMIOFILTER_API virtual FilterType getFilterType() const = 0;

    FWDICOMIOFILTER_API virtual bool isConfigurationRequired() const;

    FWDICOMIOFILTER_API virtual bool isConfigurableWithGUI() const;

    FWDICOMIOFILTER_API virtual void configureWithGUI();

protected:

    FWDICOMIOFILTER_API IFilter();

};

} // namespace fwDicomIOFilter

#endif /* __FWDICOMIOFILTER_IFILTER_HPP__ */