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 ()

virtual	~SpectrumPhy ()

virtual Ptr< NetDevice >	GetDevice ()=0
	get the associated NetDevice instance More...

virtual Ptr< MobilityModel >	GetMobility ()=0
	get the associated MobilityModel instance More...

virtual Ptr< AntennaModel >	GetRxAntenna ()=0
	get the AntennaModel used by the NetDevice for reception More...

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

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

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

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

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

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

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

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

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

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

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

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

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

Private Member Functions
	SpectrumPhy (SpectrumPhy const &)

SpectrumPhy &	operator= (SpectrumPhy const &)

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

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Abstract base class for Spectrum-aware PHY layers.

Doxygen introspection did not find any typical Config paths.

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

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

Constructor & Destructor Documentation

ns3::SpectrumPhy::SpectrumPhy ( )

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

References NS_LOG_FUNCTION.

ns3::SpectrumPhy::~SpectrumPhy ( )

virtual

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

References NS_LOG_FUNCTION.

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

private

Member Function Documentation

virtual Ptr<NetDevice> 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::RemSpectrumPhy, ns3::WaveformGenerator, and ns3::SpectrumAnalyzer.

Referenced by ns3::DownlinkLteGlobalPathlossDatabase::UpdatePathloss(), and ns3::UplinkLteGlobalPathlossDatabase::UpdatePathloss().

Here is the caller graph for this function:

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

pure virtual

get the associated MobilityModel instance

Returns: a Ptr to the associated MobilityModel instance

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

Referenced by GlobalPathlossDatabase::UpdatePathloss().

Here is the caller graph for this function:

virtual Ptr<AntennaModel> ns3::SpectrumPhy::GetRxAntenna ( )

pure virtual

get the AntennaModel used by the NetDevice for reception

Returns: a Ptr to the AntennaModel used by the NetDevice for reception

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

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::RemSpectrumPhy, ns3::WaveformGenerator, and ns3::SpectrumAnalyzer.

Referenced by ns3::MultiModelSpectrumChannel::AddRx().

Here is the caller graph for this function: