model/plc-backbone.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_BACKBONE_H_
#define PLC_BACKBONE_H_

#include <map>

#include "ns3/plc-defs.h"
#include "ns3/plc-value.h"

namespace ns3 {

class PLC_Graph;
class PLC_TxInterface;
class PLC_RxInterface;

class PLC_BackboneBranch : public Object
{
        friend class PLC_Outlet;

public:
        static TypeId GetTypeId(void);

        PLC_BackboneBranch(Ptr<PLC_Node> node, Ptr<PLC_Node> before, Ptr<PLC_Node> next, Ptr<const SpectrumModel> sm);
        ~PLC_BackboneBranch() {}

        Ptr<PLC_Node> GetNodePtr(void)          { return this->m_node; }
        PLC_Node *GetNodePeekPtr(void)          { return PeekPointer(m_node); }

        Ptr<PLC_Node> GetBeforeNodePtr(void) { return this->m_node_before; }
        PLC_Node *GetBeforeNodePeekPtr(void) { return PeekPointer(m_node_before); }

        Ptr<PLC_Node> GetNextNodePtr(void)      { return this->m_node_next; }

        void AddInterfacePair(PLC_TxInterface *txInterface, PLC_RxInterface *rxInterface);

        void DiscoverOutlets(boost::UGraph& graph_copy, PLC_Mutex *graph_copy_mutex);

        void CalculateEquivalentBridgeTapImpedance(void);

        Ptr<PLC_Impedance> GetEquivalentBridgeTapImpedance(void) const
        {
                NS_ASSERT(m_is_up_2_date);
                return m_equivalent_bridge_tap_impedance;
        }

        bool IsUp2Date(void) const { return m_is_up_2_date; }

        bool IsTimeVariant(void) const { return m_is_time_variant; }

        void SetTimeVariant(void);

        std::pair<unsigned int, std::pair<unsigned int, unsigned int> > GetKey(void) { return m_key; }

        void Lock(void) { m_branch_mutex.Lock(); }
        void Unlock(void) { m_branch_mutex.Unlock(); }

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

        Ptr<const SpectrumModel>        m_spectrum_model;
        mutable PLC_Mutex                       m_branch_mutex;
        Ptr<PLC_Node>                           m_node, m_node_before, m_node_next;
        Ptr<PLC_Impedance>                      m_equivalent_bridge_tap_impedance;

        std::map<PLC_Node *, Ptr<PLC_Impedance> > m_parallel_output_impedances;
        std::pair<unsigned int, std::pair<unsigned int, unsigned int> > m_key;

        PLC_InterfaceTupel      m_registered_ifPairs;
        bool                            m_is_up_2_date;
        bool                            m_is_time_variant;
};

}

#endif /* PLC_BACKBONE_H_ */