core/fwDataIO/include/fwDataIO/reader/IObjectReader.hpp

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

#pragma once

#include "fwDataIO/config.hpp"
#include "fwDataIO/reader/factory/new.hpp"
#include "fwDataIO/reader/registry/detail.hpp"

#include <fwCore/base.hpp>

#include <fwData/location/ILocation.hpp>

#include <fwJobs/IJob.hpp>

#include <fwTools/Object.hpp>

#include <boost/filesystem/path.hpp>

#include <cstdint>
#include <functional>

namespace fwDataIO
{

namespace reader
{

class FWDATAIO_CLASS_API IObjectReader : public ::fwCore::BaseObject
{

public:

    fwCoreNonInstanciableClassDefinitionsMacro( (IObjectReader) );

    typedef std::function< void ( std::uint64_t /*progress*/) > ProgressCallback;
    typedef std::function< void ( ) > CancelCallback;

    typedef ::fwDataIO::reader::factory::Key Key;

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

    FWDATAIO_API virtual void read() = 0;

    FWDATAIO_API virtual void setObject( ::fwTools::Object::sptr _pObject );

    FWDATAIO_API virtual ::fwTools::Object::sptr getObject();

    FWDATAIO_API virtual void setLocation( const ::fwData::location::ILocation::sptr _location );

    FWDATAIO_API virtual ::fwData::location::ILocation::sptr getLocation();

    FWDATAIO_API virtual std::string extension() = 0;

    FWDATAIO_API void cancel();

    FWDATAIO_API virtual SPTR(::fwJobs::IJob) getJob() const
    {
        return nullptr;
    }

protected:

    FWDATAIO_API IObjectReader();

    FWDATAIO_API virtual ~IObjectReader();

    ::fwTools::Object::wptr m_object;

    ::fwData::location::ILocation::sptr m_location;

};

} // namespace reader

} // namespace fwDataIO