SpectrumChannel implementation which handles a single spectrum model. More...

#include "single-model-spectrum-channel.h"

Inheritance diagram for ns3::SingleModelSpectrumChannel:

Collaboration diagram for ns3::SingleModelSpectrumChannel:

Public Types
typedef std::vector< Ptr< SpectrumPhy > >	PhyList
	Container: SpectrumPhy objects. More...

Public Types inherited from ns3::SpectrumChannel
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
	SingleModelSpectrumChannel ()

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

virtual Ptr< NetDevice >	GetDevice (std::size_t i) const

virtual std::size_t	GetNDevices (void) const

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

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

Public Member Functions inherited from ns3::SpectrumChannel
	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...

void	AddSpectrumPropagationLossModel (Ptr< SpectrumPropagationLossModel > loss)
	Add the frequency-dependent propagation loss model to be used. 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...

void	SetPropagationDelayModel (Ptr< PropagationDelayModel > delay)
	Set the propagation delay model to be used. More...

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

virtual	~Channel ()

uint32_t	GetId (void) const

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

Private Member Functions
virtual void	DoDispose ()
	Destructor implementation. More...

void	StartRx (Ptr< SpectrumSignalParameters > params, Ptr< SpectrumPhy > receiver)
	Used internally to reschedule transmission after the propagation delay. More...

Private Attributes
PhyList	m_phyList
	List of SpectrumPhy instances attached to the channel. More...

Ptr< const SpectrumModel >	m_spectrumModel
	SpectrumModel that this channel instance is supporting. 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...

Protected Attributes inherited from ns3::SpectrumChannel
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...

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

SpectrumChannel implementation which handles a single spectrum model.

All SpectrumPhy layers attached to this SpectrumChannel

Config Paths

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

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

No Attributes are defined for this type.

Attributes defined in parent class ns3::SpectrumChannel

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

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::SpectrumChannel

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 176 bytes (on a 64-bit architecture).

Definition at line 40 of file single-model-spectrum-channel.h.

Member Typedef Documentation

◆ PhyList

typedef std::vector<Ptr<SpectrumPhy> > ns3::SingleModelSpectrumChannel::PhyList

Container: SpectrumPhy objects.

Definition at line 63 of file single-model-spectrum-channel.h.

Constructor & Destructor Documentation

◆ SingleModelSpectrumChannel()

ns3::SingleModelSpectrumChannel::SingleModelSpectrumChannel ( )

Definition at line 48 of file single-model-spectrum-channel.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddRx()

void ns3::SingleModelSpectrumChannel::AddRx ( Ptr< SpectrumPhy > phy )

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.

Implements ns3::SpectrumChannel.

Definition at line 87 of file single-model-spectrum-channel.cc.

References m_phyList, NS_LOG_FUNCTION, and third::phy.

◆ DoDispose()

void ns3::SingleModelSpectrumChannel::DoDispose ( void )

privatevirtual

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

Definition at line 54 of file single-model-spectrum-channel.cc.

References ns3::SpectrumChannel::DoDispose(), m_phyList, m_spectrumModel, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetDevice()

Ptr< NetDevice > ns3::SingleModelSpectrumChannel::GetDevice ( std::size_t i ) const

virtual

Parameters

i	index of NetDevice to retrieve

Returns: one of the NetDevices connected to this channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Definition at line 229 of file single-model-spectrum-channel.cc.

References m_phyList, and NS_LOG_FUNCTION.

◆ GetNDevices()

std::size_t ns3::SingleModelSpectrumChannel::GetNDevices ( void ) const

virtual

Returns: the number of NetDevices connected to this Channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Definition at line 222 of file single-model-spectrum-channel.cc.

References m_phyList, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::SingleModelSpectrumChannel::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 63 of file single-model-spectrum-channel.cc.

References NS_LOG_FUNCTION_NOARGS, and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ RemoveRx()

void ns3::SingleModelSpectrumChannel::RemoveRx ( Ptr< SpectrumPhy > phy )

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