ns3::PLC_NoiseSource Class Reference

Base class for noise source models. More...

#include <plc-noise.h>

Inheritance diagram for ns3::PLC_NoiseSource:

List of all members.

Public Types
enum	NoiseSourceType { STATIC, TIMEVARIANT, IMPULSIVE }
Public Member Functions
	PLC_NoiseSource (Ptr< PLC_Node > src_node, Ptr< SpectrumValue > noisePsd, NoiseSourceType type)
void	SetNoisePsd (Ptr< SpectrumValue > psd)
Ptr< SpectrumValue >	GetNoisePsd (void)
NoiseSourceType	GetNoiseSourceType (void)
void	SetNode (Ptr< PLC_Node > node)
Ptr< PLC_Node >	GetNode (void)
void	SetChannel (Ptr< PLC_Channel > channel)
Ptr< PLC_Channel >	GetChannel (void)
void	Init (void)
virtual void	Enable (void)
virtual void	Disable (void)
bool	IsEnabled (void)
Static Public Member Functions
static TypeId	GetTypeId (void)
Protected Member Functions
virtual void	pureVirtualDummy (void)=0
Protected Attributes
NoiseSourceType	m_noise_source_type
uint32_t	m_noise_srcId
Ptr< PLC_Node >	m_src_node
Ptr< SpectrumValue >	m_noisePsd
Ptr< PLC_Channel >	m_channel
Ptr< PLC_TxInterface >	m_txInterface
bool	m_is_enabled
bool	m_is_initialized

---

Detailed Description

Base class for noise source models.

The noise sources act as transmitters in the PLC network. The noise PSD will therefore experience channel distortion before received by the receivers as interfering signal. Thus a a more realistic noise environment can be simulated rather than using a simple AWGN noise model.

---

Member Enumeration Documentation

enum ns3::PLC_NoiseSource::NoiseSourceType

Noise source types

currently only impulsive noise source is implemented

---

Constructor & Destructor Documentation

ns3::PLC_NoiseSource::PLC_NoiseSource	(	Ptr< PLC_Node >	src_node,
		Ptr< SpectrumValue >	noisePsd,
		NoiseSourceType	type
	)

Constructor

Parameters:

src_node	The source node where the noise source is originated
noisePsd	The noise power spectral density
type	noise source type

---

Member Function Documentation

void ns3::PLC_NoiseSource::Disable

(

void

)

[virtual]

Disable the noise source

void ns3::PLC_NoiseSource::Enable

(

void

)

[virtual]

Enable the noise source

Reimplemented in ns3::PLC_ImpulsiveNoiseSource.

Ptr<PLC_Channel> ns3::PLC_NoiseSource::GetChannel

(

void

)

[inline]

Returns:

PLC_Channel the noise source is connected to

Ptr<PLC_Node> ns3::PLC_NoiseSource::GetNode

(

void

)

[inline]

Returns:

PLC_Node the noise source is located on

Ptr<SpectrumValue> ns3::PLC_NoiseSource::GetNoisePsd

(

void

)

[inline]

Returns:

The used noise power spectral density

PLC_NoiseSource::NoiseSourceType ns3::PLC_NoiseSource::GetNoiseSourceType

(

void

)

Get noise source type

Returns:

The type of this noise source

void ns3::PLC_NoiseSource::Init

(

void

)

Initialize the noise source, i.e. create the transmit interface on the bounded node

Warning:

To be done before calling PLC_Channel::InitTransmissionChannels(), otherwise the noise source will not be known by the channel

bool ns3::PLC_NoiseSource::IsEnabled

(

void

)

Returns:

True is noise source is enabled

void ns3::PLC_NoiseSource::SetChannel

(

Ptr< PLC_Channel >

channel

)

[inline]

Set the channel the noise source is connected to

Parameters:

channel

PLC_Channel

void ns3::PLC_NoiseSource::SetNode

(

Ptr< PLC_Node >

node

)

[inline]

Bind the noise source to a specific PLC_Node

Parameters:

node

void ns3::PLC_NoiseSource::SetNoisePsd

(

Ptr< SpectrumValue >

psd

)

[inline]

Set the noise power spectral density

Parameters:

psd	The noise power spectral density

---

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

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