ns3::PLC_Interface Class Reference

Abstract base class for transmitter and receiver interfaces. More...

#include <plc-interface.h>

Inheritance diagram for ns3::PLC_Interface:

List of all members.

Public Member Functions
	PLC_Interface (Ptr< PLC_Node > associated_plc_node, Ptr< const SpectrumModel > sm)
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)
Ptr< PLC_Node >	GetNode (void) const
PLC_Node *	GetNodePeekPointer (void) const
void	Lock (void)
void	Unlock (void)
Static Public Member Functions
static TypeId	GetTypeId (void)
Protected Member Functions
virtual void	pureVirtualDummy (void)=0
virtual void	DoDispose (void)
Protected Attributes
PLC_Mutex	m_mutex
Ptr< PLC_Node >	m_plc_node
Ptr< const SpectrumModel >	m_spectrum_model
Ptr< PLC_Phy >	m_phy

---

Detailed Description

Abstract base class for transmitter and receiver interfaces.

Transmission channels will be calculated for each transmitter-receiver pair. Because not every device has to be duplex the computational costs can be reduced by distinction between transmitting and receiving interfaces

---

Constructor & Destructor Documentation

ns3::PLC_Interface::PLC_Interface	(	Ptr< PLC_Node >	associated_plc_node,
		Ptr< const SpectrumModel >	sm
	)

Constructor

Parameters:

associated_plc_node	PLC_Node the interface is located on
sm	Spectrum model

---

Member Function Documentation

Ptr< PLC_Channel > ns3::PLC_Interface::GetChannel

(

void

)

Returns:

PLC_Channel the interface is connected to

Ptr< PLC_Graph > ns3::PLC_Interface::GetGraph

(

void

)

Returns:

PLC_Graph of associated_plc_node

Ptr<PLC_Node> ns3::PLC_Interface::GetNode

(

void

)

const [inline]

Returns:

PLC_Node the interface is located on

Ptr< PLC_Phy > ns3::PLC_Interface::GetPhy

(

void

)

Returns:

PLC_Phy instance using this interface

void ns3::PLC_Interface::Lock

(

void

)

[inline]

Mutex lock and unlock

void ns3::PLC_Interface::SetNode

(

Ptr< PLC_Node >

node

)

[inline]

Bind interface to node

Parameters:

node

void ns3::PLC_Interface::SetPhy

(

Ptr< PLC_Phy >

phy

)

Define PLC_Phy instance that uses this interface

Parameters:

phy

---

The documentation for this class was generated from the following files:

• model/plc-interface.h
• model/plc-interface.cc