model/plc-edge.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) YEAR COPYRIGHTHOLDER
 *
 * 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_EDGE_H
#define PLC_EDGE_H

#include <map>

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

namespace ns3 {

class PLC_Node;
class PLC_Cable;

class PLC_Edge : public Object
{
        friend class PLC_Graph;
        friend class PLC_Outlet;

public:
        static TypeId GetTypeId(void);

        PLC_Edge(Ptr<const SpectrumModel> sm, Ptr<PLC_Node> from, Ptr<PLC_Node> to);

        virtual ~PLC_Edge() = 0;

        double GetLength(void) { return m_length; }

        void Lock() const { m_line_mutex.Lock(); }

        void Unlock() const { m_line_mutex.Unlock(); }

        PLC_Node *GetConnectedNode(PLC_Node *src_node);

        virtual void CalculateInputImpedance(PLC_Node *dst_node) = 0;

        virtual void CalculateEdgeTransferFactor(PLC_Node *dst_node) = 0;

        virtual double GetAttenuationApproxdB(void) = 0;

        virtual double GetIdealPropagationDelay(void) = 0;

        bool IsInputImpedanceUp2Date(PLC_Node *dst_node);

        bool IsEdgeTransferFactorUp2Date(PLC_Node *dst_node);

        void SetInputImpedanceOutOfDate(PLC_Node *dst_node);

        void SetEdgeTransferFactorOutOfDate(PLC_Node *dst_node);

        PLC_Impedance *GetInputImpedance(PLC_Node *dst_node);

        void CacheImpedances(PLC_Node *dst_node, Ptr<PLC_Impedance> input_impedance, Ptr<PLC_Impedance> load_impedance);

        void InitEdgeTransferFactor(PLC_Node *dst_node, bool time_variant = false);

        PLC_EdgeTransferUnit *GetEdgeTransferUnit(PLC_Node *dst_node);

        PLC_EdgeTransferUnit *GetUpdatedEdgeTransferUnit(PLC_Node *dst_node);

        std::vector<PLC_Node *> GetNodes(void);

protected:
        virtual void DoDispose(void);

        mutable PLC_Mutex                       m_line_mutex;
        Ptr<const SpectrumModel>        m_spectrum_model;
        double                                          m_propagation_delay;
        bool                                            added2graph;
        double                                          m_length;

        PLC_EdgeTransferDataMap         m_edge_transfer_data;
};

class PLC_Line : public PLC_Edge
{
        friend class PLC_Node;

public:
        static TypeId GetTypeId(void);

        PLC_Line(Ptr<PLC_Cable> cable_type, Ptr<PLC_Node> from, Ptr<PLC_Node> to);
        ~PLC_Line() {}

        /*
         * definition of the inherited pure virtual functions
         */
        double GetIdealPropagationDelay(void) { return m_propagation_delay; }

        Ptr<const PLC_Cable> GetCable(void) const { return m_cable; }
        Ptr<const PLC_FreqSelectiveImpedance> GetCharLineImp(void) const;
        Ptr<const PLC_FreqSelectiveImpedance> GetTransLineConst(void) const;

        void CalculateEdgeTransferFactor(PLC_Node *dst_node);
        double GetAttenuationApproxdB(void);

        void CalculateInputImpedance(PLC_Node *dst_node);

        template<typename ImpedanceReturnType, typename LoadImpedanceType>
        ImpedanceReturnType CalcLineInputImpedance(const LoadImpedanceType& z_l);

private:
        virtual void DoDispose(void);

        Ptr<PLC_Cable>          m_cable;
};

class PLC_TwoPort : public PLC_Edge
{
public:
        static TypeId GetTypeId(void);

        PLC_TwoPort(
                                Ptr<const SpectrumModel> sm,
                                Ptr<PLC_Node> from, Ptr<PLC_Node> to,
                                Ptr<PLC_ValueBase> A, Ptr<PLC_ValueBase> B, Ptr<PLC_ValueBase> C, Ptr<PLC_ValueBase> D
                                );

private:
        ushort timeVarianceIndicator;

        void CalculateInputImpedance(PLC_Node *dst_node);
        void CalculateEdgeTransferFactor(PLC_Node *dst_node);
        double GetAttenuationApproxdB(void);
        double GetIdealPropagationDelay(void);

        Ptr<PLC_ValueBase> m_A, m_B, m_C, m_D;
};

typedef PLC_TwoPort     PLC_Transformer;

}

#endif /* PLC_EDGE_H */