ns3::SpectrumPhy Class Reference

#include <spectrum-phy.h>

Inheritance diagram for ns3::SpectrumPhy:

[legend]

Collaboration diagram for ns3::SpectrumPhy:

[legend]

List of all members.

Public Member Functions
virtual void	SetDevice (Ptr< Object > d)=0
virtual Ptr< Object >	GetDevice ()=0
virtual void	SetMobility (Ptr< Object > m)=0
virtual Ptr< Object >	GetMobility ()=0
virtual void	SetChannel (Ptr< SpectrumChannel > c)=0
virtual Ptr< const SpectrumModel >	GetRxSpectrumModel () const =0
virtual void	StartRx (Ptr< PacketBurst > p, Ptr< const SpectrumValue > rxPsd, SpectrumType st, Time duration)=0
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::SpectrumPhy.

---

Detailed Description

Abstract base class for Spectrum-aware PHY layers

---

Member Function Documentation

virtual Ptr<Object> ns3::SpectrumPhy::GetDevice

(

)

[pure virtual]

get the associated NetDevice instance

Returns:

a Ptr to the associated NetDevice instance

Implemented in ns3::LteSpectrumPhy, ns3::HalfDuplexIdealPhy, ns3::SpectrumAnalyzer, and ns3::WaveformGenerator.

virtual Ptr<Object> ns3::SpectrumPhy::GetMobility

(

)

[pure virtual]

get the associated MobilityModel instance

Returns:

a Ptr to the associated NetDevice instance

Implemented in ns3::LteSpectrumPhy, ns3::HalfDuplexIdealPhy, ns3::SpectrumAnalyzer, and ns3::WaveformGenerator.

virtual Ptr<const SpectrumModel> ns3::SpectrumPhy::GetRxSpectrumModel

(

)

const [pure virtual]

Returns:

returns the SpectrumModel that this SpectrumPhy expects to be used for all SpectrumValues that are passed to StartRx. If 0 is returned, it means that any model will be accepted.

Implemented in ns3::LteSpectrumPhy, ns3::HalfDuplexIdealPhy, ns3::SpectrumAnalyzer, and ns3::WaveformGenerator.

static TypeId ns3::SpectrumPhy::GetTypeId

(

void

)

[static]

This method returns the TypeId associated to ns3::SpectrumPhy.

This object is accessible through the following paths with Config::Set and Config::Connect:

• /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::SpectrumPhy
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::SpectrumPhy

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.

Reimplemented in ns3::EnbLteSpectrumPhy, ns3::LteSpectrumPhy, ns3::UeLteSpectrumPhy, ns3::HalfDuplexIdealPhy, ns3::SpectrumAnalyzer, and ns3::WaveformGenerator.

virtual void ns3::SpectrumPhy::SetChannel

(

Ptr< SpectrumChannel >

c

)

[pure virtual]

Set the channel attached to this device.

Parameters:

c

the channel

Implemented in ns3::LteSpectrumPhy, ns3::HalfDuplexIdealPhy, ns3::SpectrumAnalyzer, and ns3::WaveformGenerator.

virtual void ns3::SpectrumPhy::SetDevice

(

Ptr< Object >

d

)

[pure virtual]

set the associated NetDevice instance

Parameters:

d

the NetDevice instance

Implemented in ns3::LteSpectrumPhy, ns3::HalfDuplexIdealPhy, ns3::SpectrumAnalyzer, and ns3::WaveformGenerator.

virtual void ns3::SpectrumPhy::SetMobility

(

Ptr< Object >

m

)

[pure virtual]

Set the mobility model associated with this device.

Parameters:

m

the mobility model

Implemented in ns3::LteSpectrumPhy, ns3::HalfDuplexIdealPhy, ns3::SpectrumAnalyzer, and ns3::WaveformGenerator.

virtual void ns3::SpectrumPhy::StartRx	(	Ptr< PacketBurst >	p,
		Ptr< const SpectrumValue >	rxPsd,
		SpectrumType	st,
		Time	duration
	)			[pure virtual]

Notify the SpectrumPhy instance of an incoming waveform

Parameters:

	p	the PacketBurst associated with the incoming waveform
	rxPsd	the Power Spectral Density of the incoming waveform. The units of the PSD are the same specified for SpectrumChannel::StartTx().
	st	spectrum type
	duration	the duration of the incoming waveform

Implemented in ns3::LteSpectrumPhy, ns3::HalfDuplexIdealPhy, ns3::SpectrumAnalyzer, and ns3::WaveformGenerator.

---

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

• src/node/spectrum-phy.h
• doc/introspected-doxygen.h