Defines the interface for spectrum-aware channel implementations. More...

#include <spectrum-channel.h>

Inheritance diagram for ns3::SpectrumChannel:

Collaboration diagram for ns3::SpectrumChannel:

Public Member Functions
virtual	~SpectrumChannel ()

virtual void	AddPropagationLossModel (Ptr< PropagationLossModel > loss)=0
	set the single-frequency propagation loss model to be used More...

virtual void	AddRx (Ptr< SpectrumPhy > phy)=0
	add a SpectrumPhy to a channel, so it can receive packets More...

virtual void	AddSpectrumPropagationLossModel (Ptr< SpectrumPropagationLossModel > loss)=0
	set the frequency-dependent propagation loss model to be used More...

virtual void	SetPropagationDelayModel (Ptr< PropagationDelayModel > delay)=0
	set the propagation delay model to be used More...

virtual void	StartTx (Ptr< SpectrumSignalParameters > params)=0
	Used by attached PHY instances to transmit signals on the channel. More...

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

virtual	~Channel ()

virtual Ptr< NetDevice >	GetDevice (uint32_t i) const =0

uint32_t	GetId (void) const

virtual uint32_t	GetNDevices (void) const =0

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::Channel
static TypeId	GetTypeId (void)
	Get the type ID. More...

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...

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

Defines the interface for spectrum-aware channel implementations.

Config Paths

ns3::SpectrumChannel is accessible through the following paths with Config::Set and Config::Connect:

/ChannelList/[i]/$ns3::SpectrumChannel
/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel

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

Definition at line 46 of file spectrum-channel.h.

Constructor & Destructor Documentation

ns3::SpectrumChannel::~SpectrumChannel ( )

virtual

Definition at line 38 of file spectrum-channel.cc.

Member Function Documentation

virtual void ns3::SpectrumChannel::AddPropagationLossModel ( Ptr< PropagationLossModel > loss )

pure virtual

set the single-frequency propagation loss model to be used

Warning: only models that do not depend on the TX power should be used.

Parameters

loss	a pointer to the propagation loss model to be used.

Implemented in ns3::MultiModelSpectrumChannel, and ns3::SingleModelSpectrumChannel.

Referenced by ns3::LteHelper::DoInitialize().

Here is the caller graph for this function:

virtual void ns3::SpectrumChannel::AddRx ( Ptr< SpectrumPhy > phy )

pure virtual

add a SpectrumPhy to a channel, so it can receive packets

This method is used to attach a SpectrumPhy instance to a SpectrumChannel instance, so that the SpectrumPhy can receive packets sent on that channel. Note that a SpectrumPhy that only transmits (without receiveing ever) does not need to be added to the channel.

This method is to be implemented by all classes inheriting from SpectrumChannel.

Parameters