IObjectWriter.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/writer/factory/new.hpp"
#include "fwDataIO/writer/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>

namespace fwDataIO
{

namespace writer
{

class FWDATAIO_CLASS_API IObjectWriter : public ::fwCore::BaseObject
{

public:

    fwCoreNonInstanciableClassDefinitionsMacro( (IObjectWriter) );

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

    typedef ::fwDataIO::writer::factory::Key Key;

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

    FWDATAIO_API virtual void write() = 0;

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

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

    FWDATAIO_API virtual void setObject( ::fwTools::Object::csptr object );

    FWDATAIO_API virtual ::fwTools::Object::csptr  getObject() const;

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

    FWDATAIO_API virtual void cancel();

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

protected:

    FWDATAIO_API IObjectWriter();

    FWDATAIO_API virtual ~IObjectWriter();

    ::fwTools::Object::cwptr m_object;

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

    std::string m_extension;

};

} // namespace writer

} // namespace fwDataIO