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

#include "spectrum-channel.h"

Inheritance diagram for ns3::SpectrumChannel:

Collaboration diagram for ns3::SpectrumChannel:

Public Types
typedef void(*	LossTracedCallback) (Ptr< SpectrumPhy > txPhy, Ptr< SpectrumPhy > rxPhy, double lossDb)
	TracedCallback signature for path loss calculation events. More...

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 ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

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

void	Dispose (void)
	Dispose of this Object. More...

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

virtual TypeId	GetInstanceTypeId (void) const
	Implement the GetInstanceTypeId method defined in ObjectBase. More...

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

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

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

bool	IsInitialized (void) const
	Check if the object has been initialized. 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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

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

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

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

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

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

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

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

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

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)
	Copy an Object. More...

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

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

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

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

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. 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:

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

No Attributes are defined for this type.

Attributes defined in parent class ns3::Channel

Id: The id (unique integer) of this Channel.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Flags: read

No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

typedef void(* ns3::SpectrumChannel::LossTracedCallback) (Ptr< SpectrumPhy > txPhy, Ptr< SpectrumPhy > rxPhy, double lossDb)

TracedCallback signature for path loss calculation events.

Parameters

[in]	txPhy	The TX SpectrumPhy instance.
[in]	rxPhy	The RX SpectrumPhy instance.
[in]	lossDb	The loss value, in dB.

Deprecated:: The non-const Ptr<SpectrumValue> is deprecated and will be changed to Ptr<const SpectrumValue>` in a future release.

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

Constructor & Destructor Documentation

ns3::SpectrumChannel::~SpectrumChannel ( )

virtual

Definition at line 39 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