CompareObjects.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 "fwDataCamp/config.hpp"

#include <fwCamp/camp/ExtendedClassVisitor.hpp>

#include <fwCore/Exception.hpp>
#include <fwCore/macros.hpp>

namespace fwData
{
class Object;
}

namespace fwDataCamp
{

namespace visitor
{

class FWDATACAMP_CLASS_API CompareObjects : public ::camp::ExtendedClassVisitor
{

public:

    typedef std::map< std::string, std::string > PropsMapType;

    FWDATACAMP_API CompareObjects();

    FWDATACAMP_API virtual ~CompareObjects();

    FWDATACAMP_API void visit(const camp::SimpleProperty& property);
    FWDATACAMP_API void visit(const camp::EnumProperty& property);
    FWDATACAMP_API void visit(const camp::UserProperty& property);
    FWDATACAMP_API void visit(const camp::ArrayProperty& property);
    FWDATACAMP_API void visit(const camp::Function& function);
    FWDATACAMP_API virtual void visit(const camp::MapProperty& property);
    SPTR(::fwData::Object) getReferenceObject() const
    {
        return m_objRef;
    }

    SPTR(::fwData::Object) getComparedObject() const
    {
        return m_objComp;
    }

    const PropsMapType& getReferenceProps() const
    {
        return m_propsRef;
    }

    const PropsMapType& getComparedProps() const
    {
        return m_propsComp;
    }

    SPTR(PropsMapType) getDifferences() const
    {
        return m_props;
    }

    FWDATACAMP_API void compare(SPTR(::fwData::Object) objRef,
                                SPTR(::fwData::Object) objComp);

    FWDATACAMP_API static const std::string s_MISSING_PROPERTY;

private:

    friend struct PropertyVisitor;

    CompareObjects(
        const ::camp::UserObject& obj,
        const std::string& prefix,
        SPTR(PropsMapType)props = SPTR(PropsMapType)(new PropsMapType));

    std::string getPath(const std::string& property) const;

    PropsMapType m_propsRef;

    PropsMapType m_propsComp;

    ::camp::UserObject m_campObj;

    std::string m_prefix;

    SPTR(PropsMapType) m_props;

    SPTR(::fwData::Object) m_objRef;

    SPTR(::fwData::Object) m_objComp;

};

} // namespace visitor

} // namespace fwDataCamp