model/plc-outlet.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_OUTLET_H_
#define PLC_OUTLET_H_

#include <set>
#include "ns3/object.h"
#include "ns3/plc-defs.h"
#include "ns3/plc-edge.h"
#include "ns3/plc-node.h"
#include "ns3/plc-backbone.h"

namespace ns3 {

class PLC_Node;
class PLC_RxInterface;

class PLC_Outlet : public Object
{

public:
        PLC_Outlet(Ptr<PLC_Node> node, Ptr<PLC_Impedance> impedance = 0);
        ~PLC_Outlet() {}

        static TypeId GetTypeId(void);

        void RegisterBackboneBranch(Ptr<PLC_BackboneBranch> bb_branch);

        void SetImpedance(Ptr<PLC_Impedance> impedance, bool updateImmediately = true);

        Ptr<PLC_Impedance> GetImpedance(void);

        bool IsTimeVariant(void);

        Ptr<PLC_Node> GetNode(void) { return m_node; }

        void SetRxInterface(Ptr<PLC_RxInterface> interface);

        Ptr<PLC_RxInterface> GetRxInterface(void);

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

private:
        virtual void DoDispose(void);

        mutable PLC_Mutex m_mutex;
        void AcquaintAffectedInstances(void);

        Ptr<PLC_Node> m_node;
        Ptr<PLC_RxInterface> m_rxInterface;
        std::set<Ptr<PLC_BackboneBranch> > m_registered_backbone_branches;
};

}

#endif /* PLC_OUTLET_H_ */