ns3::PLC_Cable Class Reference

#include <plc-cable.h>

Inheritance diagram for ns3::PLC_Cable:

List of all members.

Public Member Functions
	PLC_Cable ()
	PLC_Cable (Ptr< const SpectrumModel > sm)
virtual void	Calculate ()=0
	PLC_Cable (const PLC_FreqSelectiveResistance &R, const PLC_FreqSelectiveConductance &G, const PLC_FreqSelectiveInductance &L, const PLC_FreqSelectiveCapacitance &C, Ptr< const SpectrumModel > sm)
void	SetSpectrumModel (Ptr< const SpectrumModel > sm)
Ptr< const SpectrumModel >	GetSpectrumModel (void)
Ptr< const PLC_FreqSelectiveImpedance >	GetCharImp (void) const
Ptr< const PLC_FreqSelectiveImpedance >	GetTransConst (void) const
double	GetPropSpeedApprox (void)
Ptr< const SpectrumModel >	GetSpectrumModel (void) const
void	Lock ()
void	Unlock ()
PLC_FreqSelectiveResistance *	GetDistResRef (void)
PLC_FreqSelectiveResistance *	GetDistConRef (void)
Static Public Member Functions
static TypeId	GetTypeId (void)
Protected Member Functions
virtual void	DoDispose ()
void	CalcCharImp (void)
void	CalcTransConst (void)
Protected Attributes
Ptr< const SpectrumModel >	m_spectrum_model
PLC_FreqSelectiveResistance	R
PLC_FreqSelectiveConductance	G
PLC_FreqSelectiveInductance	L
PLC_FreqSelectiveCapacitance	C
Ptr< PLC_FreqSelectiveImpedance >	z_c
Ptr< PLC_FreqSelectiveImpedance >	gamma
double	v

---

Detailed Description

This class describes lossy transmission lines with the two wire conductor theory for TEM waves. Based on the distributed circuit parameters R',G',L',C' the characteristic impedance z_c and the propagation constant gamma are calculated.

---

Constructor & Destructor Documentation

ns3::PLC_Cable::PLC_Cable

(

)

[inline]

Constructor

ns3::PLC_Cable::PLC_Cable

(

Ptr< const SpectrumModel >

sm

)

Constructor

Parameters:

sm	The used spectrum model

ns3::PLC_Cable::PLC_Cable	(	const PLC_FreqSelectiveResistance &	R,
		const PLC_FreqSelectiveConductance &	G,
		const PLC_FreqSelectiveInductance &	L,
		const PLC_FreqSelectiveCapacitance &	C,
		Ptr< const SpectrumModel >	sm
	)

Parameters:

R	Distributed resistance
G	Distributed conductance
L	Distributed inductance
C	Distributed capacity
sm	Spectrum model

---

Member Function Documentation

void ns3::PLC_Cable::CalcCharImp

(

void

)

[protected]

Calculates characteristic impedance of the cable

void ns3::PLC_Cable::CalcTransConst

(

void

)

[protected]

Calculates propagation constant of the cable

Ptr< const PLC_FreqSelectiveImpedance > ns3::PLC_Cable::GetCharImp

(

void

)

const

Get the characteristic impedance of the cable

Returns:

z_c

PLC_FreqSelectiveResistance* ns3::PLC_Cable::GetDistConRef

(

void

)

[inline]

Returns:

Distributed conductance (frequency dependent)

PLC_FreqSelectiveResistance* ns3::PLC_Cable::GetDistResRef

(

void

)

[inline]

Returns:

Distributed resistance (frequency dependent)

double ns3::PLC_Cable::GetPropSpeedApprox

(

void

)

[inline]

Get the wave propagation speed for the lossless line as an approximation to calculate a signal's propagation delay

Returns:

v

Ptr<const SpectrumModel> ns3::PLC_Cable::GetSpectrumModel

(

void

)

const [inline]

Returns:

The used spectrum model

Ptr< const PLC_FreqSelectiveImpedance > ns3::PLC_Cable::GetTransConst

(

void

)

const

Get the propagation constant of the cable

Returns:

gamma

void ns3::PLC_Cable::Lock

(

void

)

[inline]

Cable mutex lock functions

---

Member Data Documentation

PLC_FreqSelectiveCapacitance ns3::PLC_Cable::C [protected]

distributed capacitance

PLC_FreqSelectiveConductance ns3::PLC_Cable::G [protected]

distributed conductance

Ptr<PLC_FreqSelectiveImpedance> ns3::PLC_Cable::gamma [protected]

transmission constant

PLC_FreqSelectiveInductance ns3::PLC_Cable::L [protected]

distributed inductance

PLC_FreqSelectiveResistance ns3::PLC_Cable::R [protected]

distributed resistance

double ns3::PLC_Cable::v [protected]

Popagation speed

assumption: flat propagation over lossless medium

Ptr<PLC_FreqSelectiveImpedance> ns3::PLC_Cable::z_c [protected]

characteristic impedance

---

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

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