Abstract base class for Spectrum-aware PHY layers. More...

#include "spectrum-phy.h"

Inheritance diagram for ns3::SpectrumPhy:

Collaboration diagram for ns3::SpectrumPhy:

Public Member Functions
	SpectrumPhy ()

	SpectrumPhy (const SpectrumPhy &)=delete

	~SpectrumPhy () override

virtual Ptr< Object >	GetAntenna () const =0
	Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception.

virtual Ptr< NetDevice >	GetDevice () const =0
	Get the associated NetDevice instance.

virtual Ptr< MobilityModel >	GetMobility () const =0
	Get the associated MobilityModel instance.

virtual Ptr< const SpectrumModel >	GetRxSpectrumModel () const =0

SpectrumPhy &	operator= (const SpectrumPhy &)=delete

virtual void	SetChannel (Ptr< SpectrumChannel > c)=0
	Set the channel attached to this device.

virtual void	SetDevice (Ptr< NetDevice > d)=0
	Set the associated NetDevice instance.

virtual void	SetMobility (Ptr< MobilityModel > m)=0
	Set the mobility model associated with this device.

virtual void	StartRx (Ptr< SpectrumSignalParameters > params)=0
	Notify the SpectrumPhy instance of an incoming signal.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Abstract base class for Spectrum-aware PHY layers.

Definition at line 34 of file spectrum-phy.h.

Constructor & Destructor Documentation

◆ SpectrumPhy() [1/2]

ns3::SpectrumPhy::SpectrumPhy ( )

Definition at line 32 of file spectrum-phy.cc.

References NS_LOG_FUNCTION.

◆ ~SpectrumPhy()

ns3::SpectrumPhy::~SpectrumPhy ( )

override

Definition at line 37 of file spectrum-phy.cc.

References NS_LOG_FUNCTION.

◆ SpectrumPhy() [2/2]

ns3::SpectrumPhy::SpectrumPhy ( const SpectrumPhy & )

delete

Member Function Documentation

◆ GetAntenna()

virtual Ptr< Object > ns3::SpectrumPhy::GetAntenna ( ) const

pure virtual

Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception.

Note that in general and depending on each module design, there can be multiple SpectrumPhy instances per NetDevice.

Returns: a Ptr to the AntennaModel used by this SpectrumPhy instance for transmission and/or reception

Implemented in ns3::HalfDuplexIdealPhy, ns3::lrwpan::LrWpanPhy, ns3::LteSimpleSpectrumPhy, ns3::LteSpectrumPhy, ns3::RemSpectrumPhy, ns3::SpectrumAnalyzer, ns3::TvSpectrumTransmitter, ns3::WaveformGenerator, and ns3::WifiSpectrumPhyInterface.

◆ GetDevice()

virtual Ptr< NetDevice > ns3::SpectrumPhy::GetDevice ( ) const

pure virtual

Get the associated NetDevice instance.

Returns: a Ptr to the associated NetDevice instance

Implemented in ns3::HalfDuplexIdealPhy, ns3::lrwpan::LrWpanPhy, ns3::LteSimpleSpectrumPhy, ns3::LteSpectrumPhy, ns3::RemSpectrumPhy, ns3::SpectrumAnalyzer, ns3::TvSpectrumTransmitter, ns3::WaveformGenerator, and ns3::WifiSpectrumPhyInterface.

◆ GetMobility()

virtual Ptr< MobilityModel > ns3::SpectrumPhy::GetMobility ( ) const

pure virtual

Get the associated MobilityModel instance.

Returns: a Ptr to the associated MobilityModel instance

Implemented in ns3::HalfDuplexIdealPhy, ns3::lrwpan::LrWpanPhy, ns3::LteSimpleSpectrumPhy, ns3::LteSpectrumPhy, ns3::RemSpectrumPhy, ns3::SpectrumAnalyzer, ns3::TvSpectrumTransmitter, ns3::WaveformGenerator, and ns3::WifiSpectrumPhyInterface.

◆ GetRxSpectrumModel()

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::HalfDuplexIdealPhy, ns3::lrwpan::LrWpanPhy, ns3::LteSimpleSpectrumPhy, ns3::LteSpectrumPhy, ns3::RemSpectrumPhy, ns3::SpectrumAnalyzer, ns3::TvSpectrumTransmitter, ns3::WaveformGenerator, and ns3::WifiSpectrumPhyInterface.

◆ GetTypeId()

TypeId ns3::SpectrumPhy::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 26 of file spectrum-phy.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ operator=()

SpectrumPhy & ns3::SpectrumPhy::operator= ( const SpectrumPhy & )

delete

◆ SetChannel()

virtual void ns3::SpectrumPhy::SetChannel ( Ptr< SpectrumChannel > c )

pure virtual

Set the channel attached to this device.

Parameters

c	the channel

Implemented in ns3::HalfDuplexIdealPhy, ns3::lrwpan::LrWpanPhy, ns3::LteSimpleSpectrumPhy, ns3::LteSpectrumPhy, ns3::RemSpectrumPhy, ns3::SpectrumAnalyzer, ns3::TvSpectrumTransmitter, ns3::WaveformGenerator, and ns3::WifiSpectrumPhyInterface.

◆ SetDevice()

virtual void ns3::SpectrumPhy::SetDevice ( Ptr< NetDevice > d )

pure virtual

Set the associated NetDevice instance.

Parameters

d	the NetDevice instance

Implemented in ns3::HalfDuplexIdealPhy, ns3::lrwpan::LrWpanPhy, ns3::LteSimpleSpectrumPhy, ns3::LteSpectrumPhy, ns3::RemSpectrumPhy, ns3::SpectrumAnalyzer, ns3::TvSpectrumTransmitter, ns3::WaveformGenerator, and ns3::WifiSpectrumPhyInterface.

◆ SetMobility()

virtual void ns3::SpectrumPhy::SetMobility ( Ptr< MobilityModel > m )

pure virtual

Set the mobility model associated with this device.

Parameters

m	the mobility model

Implemented in ns3::HalfDuplexIdealPhy, ns3::lrwpan::LrWpanPhy, ns3::LteSimpleSpectrumPhy, ns3::LteSpectrumPhy, ns3::RemSpectrumPhy, ns3::SpectrumAnalyzer, ns3::TvSpectrumTransmitter, ns3::WaveformGenerator, and ns3::WifiSpectrumPhyInterface.

◆ StartRx()

virtual void ns3::SpectrumPhy::StartRx ( Ptr< SpectrumSignalParameters > params )

pure virtual

Notify the SpectrumPhy instance of an incoming signal.

Parameters

params the parameters of the signals being received

Implemented in ns3::HalfDuplexIdealPhy, ns3::lrwpan::LrWpanPhy, ns3::LteSimpleSpectrumPhy, ns3::LteSpectrumPhy, ns3::RemSpectrumPhy, ns3::SpectrumAnalyzer, ns3::TvSpectrumTransmitter, ns3::WaveformGenerator, and ns3::WifiSpectrumPhyInterface.

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

src/spectrum/model/spectrum-phy.h
src/spectrum/model/spectrum-phy.cc

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SpectrumPhy() [1/2]

◆ ~SpectrumPhy()

◆ SpectrumPhy() [2/2]

Member Function Documentation

◆ GetAntenna()

◆ GetDevice()

◆ GetMobility()

◆ GetRxSpectrumModel()

◆ GetTypeId()

◆ operator=()

◆ SetChannel()

◆ SetDevice()

◆ SetMobility()

◆ StartRx()