LinkDescriptor.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_LINKDESCRIPTOR_HPP__
#define __FWATOMSPATCH_LINKDESCRIPTOR_HPP__

#include <map>

#include "fwCore/BaseObject.hpp"
#include "fwAtomsPatch/config.hpp"


namespace fwAtomsPatch
{

class FWATOMSPATCH_CLASS_API LinkDescriptor
{

public:

    struct Compare {
        bool operator() (LinkDescriptor a, LinkDescriptor b) const
        {
            return (a.m_originVersion+a.m_targetVersion) < (b.m_originVersion+b.m_targetVersion);
        }
    };

    typedef std::pair< std::string, std::string > VersionIDType;

    typedef std::map< VersionIDType, VersionIDType > LinksType;

    LinkDescriptor();

    LinkDescriptor(const std::string& context, const std::string& originVersion, const std::string& targetVersion,
                   const std::string& patcher, LinksType links, int weight = 1);

    ~LinkDescriptor();

    int getWeight() const
    {
        return m_weight;
    }

    const std::string& getContext() const
    {
        return m_context;
    }

    const std::string& getOriginVersion() const
    {
        return m_originVersion;
    }

    const std::string& getTargetVersion() const
    {
        return m_targetVersion;
    }

    const std::string& getPatcher() const
    {
        return m_patcher;
    }

    const LinksType& getLinks() const
    {
        return m_links;
    }

private:

    friend class VersionsGraph;

    int m_weight;

    std::string m_context;

    std::string m_originVersion;

    std::string m_targetVersion;

    std::string m_patcher;

    LinksType m_links;
};



} // fwAtomsPatch

#endif /* __FWATOMSPATCH_LINKDESCRIPTOR_HPP__ */