model/plc-graph.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2012 University of British Columbia, Vancouver
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Alexander Schloegl <alexander.schloegl@gmx.de>
 */

#ifndef PLC_GRAPH_H_
#define PLC_GRAPH_H_

#include <map>

#include <ns3/type-id.h>

#include "plc-defs.h"
#include "plc-node.h"
#include "plc-channel.h"

namespace ns3 {

class PLC_Outlet;
class PLC_BranchDiscoverVisitor;
class PLC_TxInterface;
class PLC_RxInterface;
class PLC_Channel;

class PLC_Graph : public Object
{
        friend class PLC_TxInterface;

public:
        static TypeId GetTypeId(void);

        PLC_Graph();
        ~PLC_Graph(void) {}

        void AddNode(Ptr<PLC_Node> node);

        void SetChannel(Ptr<PLC_Channel> channel) { this->m_channel = channel; }

        Ptr<PLC_Channel> GetChannel(void)
        {
                NS_ASSERT_MSG(m_channel, "Channel for the graph has not been created yet");
                return this->m_channel;
        }

        Ptr<PLC_Channel> GetChannel(void) const
        {
                NS_ASSERT_MSG(m_channel, "Channel for the graph has not been created yet");
                return this->m_channel;
        }

        std::vector<Ptr<PLC_RxInterface> > GetConnectedRxInterfaces();
        std::vector<PLC_RxInterface *> GetConnectedRxInterfacePeekPtrs(void);

        void CreatePLCGraph(void);

        Ptr<PLC_Node> GetNodePtr(unsigned int id);
        PLC_Node *GetNodePeekPtr(unsigned int id);

        std::vector<Ptr<PLC_Node> > GetNodes(void) { return m_nodes; }

        boost::UGraph *GetGraphPtr(void) { return &this->m_graph; }

        std::list<Ptr<PLC_Node> > GetShortestPath(Ptr<PLC_Node> from, Ptr<PLC_Node> to);

        double GetDistance(Ptr<PLC_Node> from, Ptr<PLC_Node> to);

        bool BackboneBranchExists(PLC_BackboneBranchKey key);

        void RegisterBackboneBranch(PLC_BackboneBranchKey bb_key, Ptr<PLC_BackboneBranch> bb_branch);

        Ptr<PLC_BackboneBranch> GetBackboneBranch(PLC_BackboneBranchKey bb_key);

        bool PathExists(Ptr<PLC_Node> from, Ptr<PLC_Node> to);

        void Lock() { m_graph_mutex.Lock(); }

        void Unlock() { m_graph_mutex.Unlock(); }

protected:
        virtual void DoStart(void);
        virtual void DoDispose(void);

        void CalculateShortestPaths(void);

        boost::UGraph           m_graph;
        mutable PLC_Mutex       m_graph_mutex;

        Ptr<PLC_Channel>        m_channel;

        std::vector<Ptr<PLC_Node> > m_nodes;

        // key<from, to> => distance + node list
        std::map<std::pair<unsigned int, unsigned int>, std::pair<double, std::list<Ptr<PLC_Node> > > > m_shortest_paths;
        std::map<PLC_BackboneBranchKey, Ptr<PLC_BackboneBranch> > m_backbone_branches;
};

}

#endif /* PLC_GRAPH_H_ */