VersionsGraph.hpp

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

#ifndef __FWATOMSPATCH_VERSIONSGRAPH_HPP__
#define __FWATOMSPATCH_VERSIONSGRAPH_HPP__

#include "fwAtomsPatch/LinkDescriptor.hpp"
#include "fwAtomsPatch/VersionDescriptor.hpp"
#include "fwAtomsPatch/config.hpp"

#include <fwCore/BaseObject.hpp>
#include <fwCore/mt/types.hpp>

#include <boost/graph/adjacency_list.hpp>
#include <boost/graph/graph_traits.hpp>

namespace fwAtomsPatch
{

class FWATOMSPATCH_CLASS_API VersionsGraph : public ::fwCore::BaseObject
{

public:
    fwCoreClassDefinitionsWithFactoryMacro( (VersionsGraph)(::fwAtomsPatch::VersionsGraph), (()), new VersionsGraph);
    fwCoreAllowSharedFromThis();

    typedef ::fwAtomsPatch::VersionDescriptor NodeType;
    typedef ::fwAtomsPatch::LinkDescriptor EdgeType;
    typedef ::boost::adjacency_list< ::boost::listS, ::boost::vecS, ::boost::directedS, NodeType, EdgeType> GraphType;
    typedef ::boost::graph_traits<GraphType>::vertex_descriptor NodeIDType;
    typedef ::boost::graph_traits<GraphType>::edge_descriptor EdgeIDType;
    typedef std::map<NodeType, NodeIDType, ::fwAtomsPatch::VersionDescriptor::Compare> ExistingNodesType;
    typedef std::map<EdgeType, EdgeIDType, ::fwAtomsPatch::LinkDescriptor::Compare> ExistingEdgesType;
    typedef std::vector< NodeIDType > VersionSeriesType;
    typedef std::pair<LinkDescriptor::VersionIDType, bool> LinkedVersionType;
    FWATOMSPATCH_API VersionsGraph();

    FWATOMSPATCH_API ~VersionsGraph();

    FWATOMSPATCH_API void addNode(NodeType node);

    FWATOMSPATCH_API void addEdge(EdgeType edge);

    FWATOMSPATCH_API VersionSeriesType shortestPath(const std::string& origin, const std::string& target);

    FWATOMSPATCH_API NodeType getNode(const NodeIDType& nodeID);

    FWATOMSPATCH_API NodeIDType getNode(const std::string& name) const;

    FWATOMSPATCH_API EdgeType getEdge(const NodeIDType& origin, const NodeIDType& target);

    FWATOMSPATCH_API LinkedVersionType getLinkedVersion(
        const NodeIDType& originID, const NodeIDType& targetID, LinkDescriptor::VersionIDType current);

    FWATOMSPATCH_API std::vector< std::string > getConnectedVersions(const std::string& currentVersion);

private:

    FWATOMSPATCH_API NodeIDType createOrUpdateNode(const NodeType& node);

    FWATOMSPATCH_API EdgeIDType createEdge(const EdgeType& edge);

    FWATOMSPATCH_API VersionSeriesType shortestPath(const NodeType& origin, const NodeType& target);

    mutable ::fwCore::mt::ReadWriteMutex m_graphMutex;

    mutable ::fwCore::mt::ReadWriteMutex m_nodesMutex;

    mutable ::fwCore::mt::ReadWriteMutex m_edgesMutex;

    GraphType m_graph;

    ExistingNodesType m_nodes;

    ExistingEdgesType m_edges;
};

} // fwAtomsPatch

#endif /* __FWATOMSPATCH_VERSIONSGRAPH_HPP__ */