A Discrete-Event Network Simulator
API
ns3::SpectrumChannel Class Referenceabstract

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...
 
 ~SpectrumChannel () override
 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...
 
void AddSpectrumTransmitFilter (Ptr< SpectrumTransmitFilter > filter)
 Add the transmit filter to be used to filter possible signal receptions at the StartTx() time. More...
 
int64_t AssignStreams (int64_t stream)
 This method calls AssignStreams() on any/all of the PropagationLossModel, PropagationDelayModel, SpectrumPropagationLossModel, PhasedArraySpectrumPropagationLossModel, and SpectrumTransmitFilter objects that have been added to this channel. More...
 
void DoDispose () override
 Destructor implementation. More...
 
Ptr< PhasedArraySpectrumPropagationLossModelGetPhasedArraySpectrumPropagationLossModel () const
 Get the frequency-dependent propagation loss model that is compatible with the phased antenna arrays at TX and RX. More...
 
Ptr< PropagationDelayModelGetPropagationDelayModel () const
 Get the propagation delay model that has been set on the channel. More...
 
Ptr< PropagationLossModelGetPropagationLossModel () const
 Get the propagation loss model. More...
 
Ptr< SpectrumPropagationLossModelGetSpectrumPropagationLossModel () const
 Get the frequency-dependent propagation loss model. More...
 
Ptr< SpectrumTransmitFilterGetSpectrumTransmitFilter () const
 Get the transmit filter, or first in a chain of transmit filters if more than one is present. 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 ()
 
 ~Channel () override
 
virtual Ptr< NetDeviceGetDevice (std::size_t i) const =0
 
uint32_t GetId () const
 
virtual std::size_t GetNDevices () const =0
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () 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< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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 () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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 ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Channel
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Protected Member Functions

virtual int64_t DoAssignStreams (int64_t stream)
 This provides a base class implementation that may be subclassed if needed by subclasses that might need additional stream assignments. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Protected Attributes

Ptr< SpectrumTransmitFilterm_filter {nullptr}
 Transmit filter to be used with this channel. More...
 
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< PhasedArraySpectrumPropagationLossModelm_phasedArraySpectrumPropagationLoss
 Frequency-dependent propagation loss model to be used with this channel. More...
 
Ptr< PropagationDelayModelm_propagationDelay
 Propagation delay model to be used with this channel. More...
 
Ptr< PropagationLossModelm_propagationLoss
 Single-frequency propagation loss model to be used with this channel. More...
 
Ptr< SpectrumPropagationLossModelm_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

Detailed Description

Defines the interface for spectrum-aware channel implementations.

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]txMobilityThe mobility model of the transmitter.
[in]rxMobilityThe mobility model of the receiver.
[in]txAntennaGainThe transmitter antenna gain, in dB.
[in]rxAntennaGainThe receiver antenna gain, in dB.
[in]propagationGainThe propagation gain, in dB.
[in]pathlossThe path loss value, in dB.

Definition at line 218 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]txPhyThe TX SpectrumPhy instance.
[in]rxPhyThe RX SpectrumPhy instance.
[in]lossDbThe loss value, in dB.

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

◆ SignalParametersTracedCallback

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

TracedCallback signature for Ptr<const SpectrumSignalParameters>.

Parameters
[in]paramsSpectrumSignalParameters instance.

Definition at line 229 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 ( )
override

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

◆ AddSpectrumTransmitFilter()

void ns3::SpectrumChannel::AddSpectrumTransmitFilter ( Ptr< SpectrumTransmitFilter filter)

Add the transmit filter to be used to filter possible signal receptions at the StartTx() time.

This method may be called multiple times to chain multiple filters together; the last filter added will be the first one used in the chain.

Parameters
filteran instance of a SpectrumTransmitFilter

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

References m_filter, and NS_LOG_FUNCTION.

◆ AssignStreams()

int64_t ns3::SpectrumChannel::AssignStreams ( int64_t  stream)

This method calls AssignStreams() on any/all of the PropagationLossModel, PropagationDelayModel, SpectrumPropagationLossModel, PhasedArraySpectrumPropagationLossModel, and SpectrumTransmitFilter objects that have been added to this channel.

If any of those objects are chained together (e.g., multiple PropagationDelayModel objects), the base class of that object is responsible for ensuring that all models in the chain have AssignStreams recursively called.

Parameters
streamthe stream index offset start
Returns
the number of stream indices assigned by this model

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

References ns3::PropagationLossModel::AssignStreams(), DoAssignStreams(), m_filter, m_phasedArraySpectrumPropagationLoss, m_propagationDelay, m_propagationLoss, m_spectrumPropagationLoss, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoAssignStreams()

int64_t ns3::SpectrumChannel::DoAssignStreams ( int64_t  stream)
protectedvirtual

This provides a base class implementation that may be subclassed if needed by subclasses that might need additional stream assignments.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

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

References NS_LOG_FUNCTION.

Referenced by AssignStreams().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::SpectrumChannel::DoDispose ( void  )
overridevirtual

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.

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

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 182 of file spectrum-channel.cc.

References m_phasedArraySpectrumPropagationLoss.

◆ GetPropagationDelayModel()

Ptr< PropagationDelayModel > ns3::SpectrumChannel::GetPropagationDelayModel ( ) const

Get the propagation delay model that has been set on the channel.

Returns
a pointer to the propagation delay model.

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

References m_propagationDelay.

◆ GetPropagationLossModel()

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

Get the propagation loss model.

Returns
a pointer to the propagation loss model.

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

References m_propagationLoss.

◆ GetSpectrumPropagationLossModel()

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

Get the frequency-dependent propagation loss model.

Returns
a pointer to the propagation loss model.

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

References m_spectrumPropagationLoss.

◆ GetSpectrumTransmitFilter()

Ptr< SpectrumTransmitFilter > ns3::SpectrumChannel::GetSpectrumTransmitFilter ( ) const

Get the transmit filter, or first in a chain of transmit filters if more than one is present.

Returns
a pointer to the transmit filter.

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

References m_filter.

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

This method will abort the simulation if there exists a previously set propagation delay model (i.e., unlike propagation loss models, multiple of which can be chained together, there is only one propagation delay model).

Parameters
delayPtr to the propagation delay model to be used.

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

References m_propagationDelay, and NS_ABORT_MSG_IF.

◆ StartTx()

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

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

Parameters
paramsthe parameters of the signals being transmitted

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

Member Data Documentation

◆ m_filter

Ptr<SpectrumTransmitFilter> ns3::SpectrumChannel::m_filter {nullptr}
protected

◆ 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 258 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 270 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 245 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 290 of file spectrum-channel.h.

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

◆ m_propagationDelay

Ptr<PropagationDelayModel> ns3::SpectrumChannel::m_propagationDelay
protected

◆ m_propagationLoss

Ptr<PropagationLossModel> ns3::SpectrumChannel::m_propagationLoss
protected

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

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

Referenced by AddPropagationLossModel(), AssignStreams(), 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 285 of file spectrum-channel.h.

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

◆ m_txSigParamsTrace

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

Traced callback for SpectrumSignalParameters in StartTx requests.

Definition at line 263 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: