IPatch.hpp

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

#ifndef __FWATOMSPATCH_IPATCH_HPP__
#define __FWATOMSPATCH_IPATCH_HPP__

#include <string>
#include <map>

#include <fwCore/base.hpp>
#include <fwAtoms/Object.hpp>
#include <fwAtomsPatch/helper/Object.hpp>

#include "fwAtomsPatch/config.hpp"


namespace fwAtomsPatch
{

class FWATOMSPATCH_CLASS_API IPatch : public ::fwCore::BaseObject
{

public:
    fwCoreNonInstanciableClassDefinitionsMacro((IPatch));
    fwCoreAllowSharedFromThis();

    typedef std::map< ::fwAtoms::Object::sptr, ::fwAtoms::Object::sptr > NewVersionsType;
    FWATOMSPATCH_API IPatch();

    FWATOMSPATCH_API IPatch( const IPatch &cpy );

    FWATOMSPATCH_API virtual ~IPatch();

    FWATOMSPATCH_API virtual void apply(const ::fwAtoms::Object::sptr& previous,
                                        const ::fwAtoms::Object::sptr& current,
                                        ::fwAtomsPatch::IPatch::NewVersionsType& newVersions) = 0;

    FWATOMSPATCH_API virtual const std::string& getOriginClassname() const;

    FWATOMSPATCH_API virtual const std::string& getOriginVersion() const;


protected:

    std::string m_originClassname;

    std::string m_originVersion;

};


} //fwAtomsPatch
#endif /* __FWATOMSPATCH_IPATCH_HPP__ */