model/plc-interface.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_INTERFACE_H_
#define PLC_INTERFACE_H_

#include <map>

#include <ns3/node.h>
#include <ns3/spectrum-model.h>
#include <ns3/plc-graph.h>
#include <ns3/plc-backbone.h>
#include <ns3/plc-defs.h>
#include <ns3/packet-burst.h>
#include <ns3/spectrum-value.h>
#include <ns3/traced-callback.h>
#include <ns3/data-rate.h>
#include <ns3/event-id.h>

#include "plc-phy.h"

namespace ns3 {

class PLC_Node;
class PLC_Outlet;
class PLC_Graph;
class PLC_BackboneBranch;
class PLC_ChannelTransferImpl;
class PLC_Channel;
class PLC_Phy;
class PLC_TrxMetaInfo;

class PLC_Interface : public Object
{
public:
        static TypeId GetTypeId(void);

        PLC_Interface(Ptr<PLC_Node> associated_plc_node, Ptr<const SpectrumModel> sm);
        virtual ~PLC_Interface() = 0;

        Ptr<PLC_Graph> GetGraph(void);

        Ptr<PLC_Channel> GetChannel(void);

        void SetPhy(Ptr<PLC_Phy> phy);

        Ptr<PLC_Phy> GetPhy(void);

        void SetNode(Ptr<PLC_Node> node) { this->m_plc_node = node; }

        Ptr<PLC_Node> GetNode(void) const { return m_plc_node; }
        PLC_Node *GetNodePeekPointer(void) const { return PeekPointer(m_plc_node); }

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

protected:
    // pure virtual dummy function to keep pybindgen happy
    virtual void pureVirtualDummy(void) = 0;
        virtual void DoDispose(void);

        mutable PLC_Mutex                       m_mutex;
        Ptr<PLC_Node>                           m_plc_node;
        Ptr<const SpectrumModel>        m_spectrum_model;
        Ptr<PLC_Phy>                            m_phy;
};

class PLC_TxInterface : public PLC_Interface
{
        friend class PLC_Outlet;

public:
        static TypeId GetTypeId(void);

        PLC_TxInterface(Ptr<PLC_Node> associated_plc_node, Ptr<const SpectrumModel> sm);
        ~PLC_TxInterface() {}

        void SetIdx(uint32_t idx) { m_txIfIdx = idx; }

        uint32_t GetTxIfIdx(void) const;

        Ptr<const SpectrumValue> GetTxPsd(void) { return m_txPsd; }

        void InitializeChannelTransferImpls(void);

        void CalculateChannels(void);

        PLC_ChannelTransferImpl *GetChannelTransferImpl(PLC_RxInterface *rxInterface);

        std::list<PLC_BackboneBranch *> GetBackbonePath(PLC_RxInterface *sink);

        PLC_BackbonePath::iterator BackbonePathBegin(PLC_RxInterface *sink);

        PLC_BackbonePath::iterator BackbonePathEnd(PLC_RxInterface *sink);

        void StartTx(Ptr<const Packet> p, Ptr<const SpectrumValue> txPsd, Time duration, Ptr<const PLC_TrxMetaInfo> metaInfo);

private:
    // virtual dummy function to keep pybindgen happy
    virtual void pureVirtualDummy(void) {}
        virtual void DoStart(void);
        virtual void DoDispose(void);

        // currently all rx interfaces are taken into account
        // even if they are too far away
        bool IsWithinRange(PLC_RxInterface *rxInterface);
        bool IsCenterFreqWithinRange(PLC_RxInterface *rxInterface);

        void RegisterRxInterface(PLC_RxInterface *rxInterface);

        // called by PLC_Outlet
        void SetChannelTransferImplsOutOfDate(void);
        void SetTimeVariantChannel(PLC_RxInterface *rx);

        bool m_all_bb_up2date;
        uint32_t m_txIfIdx;
        Ptr<const SpectrumValue> m_txPsd;
        std::map<PLC_RxInterface *, Ptr<PLC_ChannelTransferImpl> >  m_channel_transfer_impls;
};

class PLC_RxInterface : public PLC_Interface
{
public:
        static TypeId GetTypeId(void);

        PLC_RxInterface(Ptr<PLC_Node> associated_node, Ptr<const SpectrumModel> sm);
        ~PLC_RxInterface() {}

        void SetIdx(uint32_t idx) { m_rxIfIdx = idx; }

        uint32_t GetRxIfIdx(void) const;

        void SetOutlet(Ptr<PLC_Outlet> outlet);

        Ptr<PLC_Outlet> GetOutlet(void) { return m_outlet; }

        void StartRx(Ptr<const Packet> p, uint32_t txId, Ptr<SpectrumValue>& rxPsd, Time duration, Ptr<const PLC_TrxMetaInfo> metaInfo);

        void RxPsdChanged(uint32_t txId, Ptr<SpectrumValue> rxSignal);

private:
    // virtual dummy function to keep pybindgen happy
    virtual void pureVirtualDummy(void) {}
        virtual void DoStart(void);
        virtual void DoDispose(void);

        Ptr<PLC_Outlet> m_outlet;

        bool m_is_up_2_date;
        uint32_t m_rxIfIdx;
};

} // namespace ns3

#endif /* PLC_INTERFACE_H_ */