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(*	GainTracedCallback) (Ptr< const MobilityModel > txMobility, Ptr< const MobilityModel > rxMobility, double txAntennaGain, double rxAntennaGain, double propagationGain, double pathloss)
	TracedCallback signature for path loss calculation events. More...

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

typedef void(*	SignalParametersTracedCallback) (Ptr< SpectrumSignalParameters > params)
	TracedCallback signature for Ptr<const SpectrumSignalParameters>. More...

Public Member Functions
	SpectrumChannel ()
	constructor More...

virtual	~SpectrumChannel ()
	destructor More...

void	AddPhasedArraySpectrumPropagationLossModel (Ptr< PhasedArraySpectrumPropagationLossModel > loss)
	Add the frequency-dependent propagation loss model that is compapatible with the phased antenna arrays at the TX and RX. More...

void	AddPropagationLossModel (Ptr< PropagationLossModel > loss)
	Add 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...

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

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

Ptr< PhasedArraySpectrumPropagationLossModel >	GetPhasedArraySpectrumPropagationLossModel (void)
	Get the frequency-dependent propagation loss model that is compatible with the phased antenna arrays at TX and RX. More...

Ptr< PropagationLossModel >	GetPropagationLossModel (void)
	Get the propagation loss model. More...

Ptr< SpectrumPropagationLossModel >	GetSpectrumPropagationLossModel (void)
	Get the frequency-dependent propagation loss model. More...

virtual void	RemoveRx (Ptr< SpectrumPhy > phy)=0
	Remove a SpectrumPhy from a channel. More...

void	SetPropagationDelayModel (Ptr< PropagationDelayModel > delay)
	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 (std::size_t i) const =0

uint32_t	GetId (void) const

virtual std::size_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
	Get the most derived TypeId for this Object. More...

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

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

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

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. 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 ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. 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::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Attributes
TracedCallback< Ptr< const MobilityModel >, Ptr< const MobilityModel >, double, double, double, double >	m_gainTrace
	The `Gain` trace source. More...

double	m_maxLossDb
	Maximum loss [dB]. More...

TracedCallback< Ptr< const SpectrumPhy >, Ptr< const SpectrumPhy >, double >	m_pathLossTrace
	The `PathLoss` trace source. More...

Ptr< PhasedArraySpectrumPropagationLossModel >	m_phasedArraySpectrumPropagationLoss
	Frequency-dependent propagation loss model to be used with this channel. More...

Ptr< PropagationDelayModel >	m_propagationDelay
	Propagation delay model to be used with this channel. More...

Ptr< PropagationLossModel >	m_propagationLoss
	Single-frequency propagation loss model to be used with this channel. More...

Ptr< SpectrumPropagationLossModel >	m_spectrumPropagationLoss
	Frequency-dependent propagation loss model to be used with this channel. More...

TracedCallback< Ptr< SpectrumSignalParameters > >	m_txSigParamsTrace
	Traced callback for SpectrumSignalParameters in StartTx requests. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. 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::WifiNetDevice/Channel/$ns3::SpectrumChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SpectrumChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel"
"/ChannelList/[i]/$ns3::SpectrumChannel"

Attributes

MaxLossDb: If a single-frequency PropagationLossModel is used, this value represents the maximum loss in dB for which transmissions will be passed to the receiving PHY. Signals for which the PropagationLossModel returns a loss bigger than this value will not be propagated to the receiver. This parameter is to be used to reduce the computational load by not propagating signals that are far beyond the interference range. Note that the default value corresponds to considering all signals for reception. Tune this value with care.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1e+09
- Flags: construct write read
PropagationLossModel: A pointer to the propagation loss model attached to this channel.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::PropagationLossModel>
- Initial value: 0
- Flags: construct write read

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

TraceSources

Gain: This trace is fired whenever a new path loss value is calculated. The parameters to this trace are : Pointer to the mobility model of the transmitterPointer to the mobility model of the receiverTx antenna gainRx antenna gainPropagation gainPathloss
Callback signature: ns3::SpectrumChannel::GainTracedCallback
PathLoss: This trace is fired whenever a new path loss value is calculated. The first and second parameters to the trace are pointers respectively to the TX and RX SpectrumPhy instances, whereas the third parameters is the loss value in dB. Note that the loss value reported by this trace is the single-frequency loss value obtained by evaluating only the TX and RX AntennaModels and the PropagationLossModel. In particular, note that SpectrumPropagationLossModel (even if present) is never used to evaluate the loss value reported in this trace.
Callback signature: ns3::SpectrumChannel::LossTracedCallback
TxSigParams: This trace is fired whenever a signal is transmitted.The sole parameter is a pointer to a copy of the SpectrumSignalParameters provided by the transmitter.
Callback signature: ns3::SpectrumChannel::SignalParametersTracedCallback

Size of this type is 144 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

◆ GainTracedCallback

typedef void(* ns3::SpectrumChannel::GainTracedCallback) (Ptr< const MobilityModel > txMobility, Ptr< const MobilityModel > rxMobility, double txAntennaGain, double rxAntennaGain, double propagationGain, double pathloss)

TracedCallback signature for path loss calculation events.

Parameters

[in]	txMobility	The mobility model of the transmitter.
[in]	rxMobility	The mobility model of the receiver.
[in]	txAntennaGain	The transmitter antenna gain, in dB.
[in]	rxAntennaGain	The receiver antenna gain, in dB.
[in]	propagationGain	The propagation gain, in dB.
[in]	pathloss	The path loss value, in dB.

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

◆ LossTracedCallback

typedef void(* ns3::SpectrumChannel::LossTracedCallback) (Ptr< const SpectrumPhy > txPhy, Ptr< const 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.

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

◆ SignalParametersTracedCallback

typedef void(* ns3::SpectrumChannel::SignalParametersTracedCallback) (Ptr< SpectrumSignalParameters > params)

TracedCallback signature for Ptr<const SpectrumSignalParameters>.

Parameters

[in] params SpectrumSignalParameters instance.

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

Constructor & Destructor Documentation

◆ SpectrumChannel()

ns3::SpectrumChannel::SpectrumChannel ( )

constructor

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

References NS_LOG_FUNCTION.

◆ ~SpectrumChannel()

ns3::SpectrumChannel::~SpectrumChannel ( )

virtual

destructor

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

Member Function Documentation

◆ AddPhasedArraySpectrumPropagationLossModel()

void ns3::SpectrumChannel::AddPhasedArraySpectrumPropagationLossModel ( Ptr< PhasedArraySpectrumPropagationLossModel > loss )

Add the frequency-dependent propagation loss model that is compapatible with the phased antenna arrays at the TX and RX.

Parameters

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

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

References m_phasedArraySpectrumPropagationLoss, and NS_LOG_FUNCTION.

◆ AddPropagationLossModel()

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

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

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

References m_propagationLoss, NS_LOG_FUNCTION, and ns3::PropagationLossModel::SetNext().

Here is the call graph for this function:

◆ AddRx()

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 receiving ever) does not need to be added to the channel.

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

Parameters

phy	the SpectrumPhy instance to be added to the channel as a receiver.

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

◆ AddSpectrumPropagationLossModel()

void ns3::SpectrumChannel::AddSpectrumPropagationLossModel ( Ptr< SpectrumPropagationLossModel > loss )

Add the frequency-dependent propagation loss model to be used.

Parameters

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

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

References m_spectrumPropagationLoss, and NS_LOG_FUNCTION.

◆ DoDispose()

void ns3::SpectrumChannel::DoDispose ( void )

virtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

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

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

References m_propagationDelay, m_propagationLoss, m_spectrumPropagationLoss, and NS_LOG_FUNCTION.

Referenced by ns3::MultiModelSpectrumChannel::DoDispose(), and ns3::SingleModelSpectrumChannel::DoDispose().

Here is the caller graph for this function:

◆ GetPhasedArraySpectrumPropagationLossModel()

Ptr< PhasedArraySpectrumPropagationLossModel > ns3::SpectrumChannel::GetPhasedArraySpectrumPropagationLossModel ( void )

Get the frequency-dependent propagation loss model that is compatible with the phased antenna arrays at TX and RX.

Returns: a pointer to the propagation loss model.

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

References m_phasedArraySpectrumPropagationLoss, and NS_LOG_FUNCTION.

◆ GetPropagationLossModel()

Ptr< PropagationLossModel > ns3::SpectrumChannel::GetPropagationLossModel ( void )

Get the propagation loss model.

Returns: a pointer to the propagation loss model.

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

References m_propagationLoss.

◆ GetSpectrumPropagationLossModel()

Ptr< SpectrumPropagationLossModel > ns3::SpectrumChannel::GetSpectrumPropagationLossModel ( void )

Get the frequency-dependent propagation loss model.

Returns: a pointer to the propagation loss model.

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

References m_spectrumPropagationLoss, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::SpectrumChannel::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References m_gainTrace, m_maxLossDb, m_pathLossTrace, m_propagationLoss, m_txSigParamsTrace, ns3::MakeDoubleAccessor(), ns3::MakePointerAccessor(), ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ RemoveRx()

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

pure virtual

Remove a SpectrumPhy from a channel.

This method is used to detach a SpectrumPhy instance from a SpectrumChannel instance, so that the SpectrumPhy does not receive packets sent on that channel.

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

Parameters

phy	the SpectrumPhy instance to be removed from the channel as a receiver.

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

◆ SetPropagationDelayModel()

void ns3::SpectrumChannel::SetPropagationDelayModel ( Ptr< PropagationDelayModel > delay )

Set the propagation delay model to be used.

Parameters

delay Ptr to the propagation delay model to be used.

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

References m_propagationDelay, and NS_ASSERT.

◆ StartTx()

virtual void ns3::SpectrumChannel::StartTx ( Ptr< SpectrumSignalParameters > params )

pure virtual

Used by attached PHY instances to transmit signals on the channel.

Parameters

params the parameters of the signals being transmitted

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

Member Data Documentation

◆ m_gainTrace

TracedCallback<Ptr<const MobilityModel>, Ptr<const MobilityModel>, double, double, double, double> ns3::SpectrumChannel::m_gainTrace

protected

The Gain trace source.

Fired whenever a new path loss value is calculated. Exporting pointer to the mobility model of the transmitter and the receiver, Tx antenna gain, Rx antenna gain, propagation gain and pathloss

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

Referenced by GetTypeId(), ns3::MultiModelSpectrumChannel::StartTx(), and ns3::SingleModelSpectrumChannel::StartTx().

◆ m_maxLossDb

double ns3::SpectrumChannel::m_maxLossDb

protected

Maximum loss [dB].

Any device above this loss is considered out of range.

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

Referenced by GetTypeId(), ns3::MultiModelSpectrumChannel::StartTx(), and ns3::SingleModelSpectrumChannel::StartTx().

◆ m_pathLossTrace

TracedCallback<Ptr<const SpectrumPhy>, Ptr<const SpectrumPhy>, double > ns3::SpectrumChannel::m_pathLossTrace

protected

The PathLoss trace source.

Exporting the pointers to the Tx and Rx SpectrumPhy and a pathloss value, in dB.

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

Referenced by GetTypeId(), ns3::MultiModelSpectrumChannel::StartTx(), and ns3::SingleModelSpectrumChannel::StartTx().

◆ m_phasedArraySpectrumPropagationLoss

Ptr<PhasedArraySpectrumPropagationLossModel> ns3::SpectrumChannel::m_phasedArraySpectrumPropagationLoss

protected

Frequency-dependent propagation loss model to be used with this channel.

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

Referenced by AddPhasedArraySpectrumPropagationLossModel(), GetPhasedArraySpectrumPropagationLossModel(), and ns3::MultiModelSpectrumChannel::StartTx().

◆ m_propagationDelay

Ptr<PropagationDelayModel> ns3::SpectrumChannel::m_propagationDelay

protected

Propagation delay model to be used with this channel.

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

Referenced by DoDispose(), SetPropagationDelayModel(), ns3::MultiModelSpectrumChannel::StartTx(), and ns3::SingleModelSpectrumChannel::StartTx().

◆ m_propagationLoss

Ptr<PropagationLossModel> ns3::SpectrumChannel::m_propagationLoss

protected

Single-frequency propagation loss model to be used with this channel.

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

Referenced by AddPropagationLossModel(), DoDispose(), GetPropagationLossModel(), GetTypeId(), ns3::MultiModelSpectrumChannel::StartTx(), and ns3::SingleModelSpectrumChannel::StartTx().

◆ m_spectrumPropagationLoss

Ptr<SpectrumPropagationLossModel> ns3::SpectrumChannel::m_spectrumPropagationLoss

protected

Frequency-dependent propagation loss model to be used with this channel.

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

Referenced by AddSpectrumPropagationLossModel(), DoDispose(), GetSpectrumPropagationLossModel(), ns3::MultiModelSpectrumChannel::StartTx(), and ns3::SingleModelSpectrumChannel::StartTx().

◆ m_txSigParamsTrace

TracedCallback<Ptr<SpectrumSignalParameters> > ns3::SpectrumChannel::m_txSigParamsTrace

protected

Traced callback for SpectrumSignalParameters in StartTx requests.

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

Referenced by GetTypeId(), ns3::MultiModelSpectrumChannel::StartTx(), and ns3::SingleModelSpectrumChannel::StartTx().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Channel

TraceSources

Member Typedef Documentation

◆ GainTracedCallback

◆ LossTracedCallback

◆ SignalParametersTracedCallback

Constructor & Destructor Documentation

◆ SpectrumChannel()

◆ ~SpectrumChannel()

Member Function Documentation

◆ AddPhasedArraySpectrumPropagationLossModel()

◆ AddPropagationLossModel()

◆ AddRx()

◆ AddSpectrumPropagationLossModel()

◆ DoDispose()

◆ GetPhasedArraySpectrumPropagationLossModel()

◆ GetPropagationLossModel()

◆ GetSpectrumPropagationLossModel()

◆ GetTypeId()

◆ RemoveRx()

◆ SetPropagationDelayModel()

◆ StartTx()

Member Data Documentation

◆ m_gainTrace

◆ m_maxLossDb

◆ m_pathLossTrace

◆ m_phasedArraySpectrumPropagationLoss

◆ m_propagationDelay

◆ m_propagationLoss

◆ m_spectrumPropagationLoss

◆ m_txSigParamsTrace