Defines the interface for spectrum-aware channel implementations. More...
#include "spectrum-channel.h"
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. | |
typedef void(* | LossTracedCallback) (Ptr< const SpectrumPhy > txPhy, Ptr< const SpectrumPhy > rxPhy, double lossDb) |
TracedCallback signature for path loss calculation events. | |
typedef void(* | SignalParametersTracedCallback) (Ptr< SpectrumSignalParameters > params) |
TracedCallback signature for Ptr<const SpectrumSignalParameters>. | |
Public Member Functions | |
SpectrumChannel () | |
constructor | |
~SpectrumChannel () override | |
destructor | |
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. | |
void | AddPropagationLossModel (Ptr< PropagationLossModel > loss) |
Add the single-frequency propagation loss model to be used. | |
virtual void | AddRx (Ptr< SpectrumPhy > phy)=0 |
Add a SpectrumPhy to a channel, so it can receive packets. | |
void | AddSpectrumPropagationLossModel (Ptr< SpectrumPropagationLossModel > loss) |
Add the frequency-dependent propagation loss model to be used. | |
void | AddSpectrumTransmitFilter (Ptr< SpectrumTransmitFilter > filter) |
Add the transmit filter to be used to filter possible signal receptions at the StartTx() time. | |
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. | |
void | DoDispose () override |
Destructor implementation. | |
Ptr< PhasedArraySpectrumPropagationLossModel > | GetPhasedArraySpectrumPropagationLossModel () const |
Get the frequency-dependent propagation loss model that is compatible with the phased antenna arrays at TX and RX. | |
Ptr< PropagationDelayModel > | GetPropagationDelayModel () const |
Get the propagation delay model that has been set on the channel. | |
Ptr< PropagationLossModel > | GetPropagationLossModel () const |
Get the propagation loss model. | |
Ptr< SpectrumPropagationLossModel > | GetSpectrumPropagationLossModel () const |
Get the frequency-dependent propagation loss model. | |
Ptr< SpectrumTransmitFilter > | GetSpectrumTransmitFilter () const |
Get the transmit filter, or first in a chain of transmit filters if more than one is present. | |
virtual void | RemoveRx (Ptr< SpectrumPhy > phy)=0 |
Remove a SpectrumPhy from a channel. | |
void | SetPropagationDelayModel (Ptr< PropagationDelayModel > delay) |
Set the propagation delay model to be used. | |
virtual void | StartTx (Ptr< SpectrumSignalParameters > params)=0 |
Used by attached PHY instances to transmit signals on the channel. | |
Public Member Functions inherited from ns3::Channel | |
Channel () | |
~Channel () override | |
virtual Ptr< NetDevice > | GetDevice (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. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Channel | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
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. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Protected Attributes | |
Ptr< SpectrumTransmitFilter > | m_filter {nullptr} |
Transmit filter to be used with this channel. | |
TracedCallback< Ptr< const MobilityModel >, Ptr< const MobilityModel >, double, double, double, double > | m_gainTrace |
The Gain trace source. | |
double | m_maxLossDb |
Maximum loss [dB]. | |
TracedCallback< Ptr< const SpectrumPhy >, Ptr< const SpectrumPhy >, double > | m_pathLossTrace |
The PathLoss trace source. | |
Ptr< PhasedArraySpectrumPropagationLossModel > | m_phasedArraySpectrumPropagationLoss |
Frequency-dependent propagation loss model to be used with this channel. | |
Ptr< PropagationDelayModel > | m_propagationDelay |
Propagation delay model to be used with this channel. | |
Ptr< PropagationLossModel > | m_propagationLoss |
Single-frequency propagation loss model to be used with this channel. | |
Ptr< SpectrumPropagationLossModel > | m_spectrumPropagationLoss |
Frequency-dependent propagation loss model to be used with this channel. | |
TracedCallback< Ptr< SpectrumSignalParameters > > | m_txSigParamsTrace |
Traced callback for SpectrumSignalParameters in StartTx requests. | |
Additional Inherited Members | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Defines the interface for spectrum-aware channel implementations.
ns3::SpectrumChannel is accessible through the following paths with Config::Set and Config::Connect:
Group: Spectrum
Size of this type is 176 bytes (on a 64-bit architecture).
Definition at line 38 of file spectrum-channel.h.
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.
[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 207 of file spectrum-channel.h.
typedef void(* ns3::SpectrumChannel::LossTracedCallback) (Ptr< const SpectrumPhy > txPhy, Ptr< const SpectrumPhy > rxPhy, double lossDb) |
TracedCallback signature for path loss calculation events.
[in] | txPhy | The TX SpectrumPhy instance. |
[in] | rxPhy | The RX SpectrumPhy instance. |
[in] | lossDb | The loss value, in dB. |
Definition at line 194 of file spectrum-channel.h.
typedef void(* ns3::SpectrumChannel::SignalParametersTracedCallback) (Ptr< SpectrumSignalParameters > params) |
TracedCallback signature for Ptr<const SpectrumSignalParameters>.
[in] | params | SpectrumSignalParameters instance. |
Definition at line 218 of file spectrum-channel.h.
ns3::SpectrumChannel::SpectrumChannel | ( | ) |
|
override |
destructor
Definition at line 28 of file spectrum-channel.cc.
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.
loss | a pointer to the propagation loss model to be used. |
Definition at line 128 of file spectrum-channel.cc.
References m_phasedArraySpectrumPropagationLoss, and NS_LOG_FUNCTION.
void ns3::SpectrumChannel::AddPropagationLossModel | ( | Ptr< PropagationLossModel > | loss | ) |
Add the single-frequency propagation loss model to be used.
loss | a pointer to the propagation loss model to be used. |
Definition at line 106 of file spectrum-channel.cc.
References m_propagationLoss, and NS_LOG_FUNCTION.
|
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.
phy | the SpectrumPhy instance to be added to the channel as a receiver. |
Implemented in ns3::MultiModelSpectrumChannel, and ns3::SingleModelSpectrumChannel.
void ns3::SpectrumChannel::AddSpectrumPropagationLossModel | ( | Ptr< SpectrumPropagationLossModel > | loss | ) |
Add the frequency-dependent propagation loss model to be used.
loss | a pointer to the propagation loss model to be used. |
Definition at line 117 of file spectrum-channel.cc.
References m_spectrumPropagationLoss, and NS_LOG_FUNCTION.
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.
filter | an instance of a SpectrumTransmitFilter |
Definition at line 140 of file spectrum-channel.cc.
References m_filter, and NS_LOG_FUNCTION.
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.
stream | the stream index offset start |
Definition at line 189 of file spectrum-channel.cc.
References DoAssignStreams(), m_filter, m_phasedArraySpectrumPropagationLoss, m_propagationDelay, m_propagationLoss, m_spectrumPropagationLoss, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
|
protectedvirtual |
This provides a base class implementation that may be subclassed if needed by subclasses that might need additional stream assignments.
stream | first stream index to use |
Definition at line 250 of file spectrum-channel.cc.
References NS_LOG_FUNCTION.
Referenced by AssignStreams().
|
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 33 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().
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.
Definition at line 171 of file spectrum-channel.cc.
References m_phasedArraySpectrumPropagationLoss.
Ptr< PropagationDelayModel > ns3::SpectrumChannel::GetPropagationDelayModel | ( | ) | const |
Get the propagation delay model that has been set on the channel.
Definition at line 183 of file spectrum-channel.cc.
References m_propagationDelay.
Ptr< PropagationLossModel > ns3::SpectrumChannel::GetPropagationLossModel | ( | ) | const |
Get the propagation loss model.
Definition at line 177 of file spectrum-channel.cc.
References m_propagationLoss.
Ptr< SpectrumPropagationLossModel > ns3::SpectrumChannel::GetSpectrumPropagationLossModel | ( | ) | const |
Get the frequency-dependent propagation loss model.
Definition at line 165 of file spectrum-channel.cc.
References m_spectrumPropagationLoss.
Ptr< SpectrumTransmitFilter > ns3::SpectrumChannel::GetSpectrumTransmitFilter | ( | ) | const |
Get the transmit filter, or first in a chain of transmit filters if more than one is present.
Definition at line 152 of file spectrum-channel.cc.
References m_filter.
|
static |
Get the type ID.
Definition at line 42 of file spectrum-channel.cc.
References m_gainTrace, m_maxLossDb, m_pathLossTrace, m_propagationLoss, m_txSigParamsTrace, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakePointerAccessor(), ns3::MakePointerChecker(), ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
|
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.
phy | the SpectrumPhy instance to be removed from the channel as a receiver. |
Implemented in ns3::MultiModelSpectrumChannel, and ns3::SingleModelSpectrumChannel.
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).
delay | Ptr to the propagation delay model to be used. |
Definition at line 158 of file spectrum-channel.cc.
References m_propagationDelay, and NS_ABORT_MSG_IF.
|
pure virtual |
Used by attached PHY instances to transmit signals on the channel.
params | the parameters of the signals being transmitted |
Implemented in ns3::MultiModelSpectrumChannel, and ns3::SingleModelSpectrumChannel.
|
protected |
Transmit filter to be used with this channel.
Definition at line 284 of file spectrum-channel.h.
Referenced by AddSpectrumTransmitFilter(), AssignStreams(), GetSpectrumTransmitFilter(), ns3::MultiModelSpectrumChannel::StartTx(), and ns3::SingleModelSpectrumChannel::StartTx().
|
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 247 of file spectrum-channel.h.
Referenced by GetTypeId(), ns3::MultiModelSpectrumChannel::StartRx(), and ns3::SingleModelSpectrumChannel::StartTx().
|
protected |
Maximum loss [dB].
Any device above this loss is considered out of range.
Definition at line 259 of file spectrum-channel.h.
Referenced by GetTypeId(), ns3::MultiModelSpectrumChannel::StartRx(), and ns3::SingleModelSpectrumChannel::StartTx().
|
protected |
The PathLoss
trace source.
Exporting the pointers to the Tx and Rx SpectrumPhy and a pathloss value, in dB.
Definition at line 234 of file spectrum-channel.h.
Referenced by GetTypeId(), ns3::MultiModelSpectrumChannel::StartRx(), and ns3::SingleModelSpectrumChannel::StartTx().
|
protected |
Frequency-dependent propagation loss model to be used with this channel.
Definition at line 279 of file spectrum-channel.h.
Referenced by AddPhasedArraySpectrumPropagationLossModel(), AssignStreams(), GetPhasedArraySpectrumPropagationLossModel(), and ns3::MultiModelSpectrumChannel::StartRx().
|
protected |
Propagation delay model to be used with this channel.
Definition at line 269 of file spectrum-channel.h.
Referenced by AssignStreams(), DoDispose(), GetPropagationDelayModel(), SetPropagationDelayModel(), ns3::MultiModelSpectrumChannel::StartTx(), and ns3::SingleModelSpectrumChannel::StartTx().
|
protected |
Single-frequency propagation loss model to be used with this channel.
Definition at line 264 of file spectrum-channel.h.
Referenced by AddPropagationLossModel(), AssignStreams(), DoDispose(), GetPropagationLossModel(), GetTypeId(), ns3::MultiModelSpectrumChannel::StartRx(), and ns3::SingleModelSpectrumChannel::StartTx().
|
protected |
Frequency-dependent propagation loss model to be used with this channel.
Definition at line 274 of file spectrum-channel.h.
Referenced by AddSpectrumPropagationLossModel(), AssignStreams(), DoDispose(), GetSpectrumPropagationLossModel(), ns3::MultiModelSpectrumChannel::StartRx(), and ns3::SingleModelSpectrumChannel::StartRx().
|
protected |
Traced callback for SpectrumSignalParameters in StartTx requests.
Definition at line 252 of file spectrum-channel.h.
Referenced by GetTypeId(), ns3::MultiModelSpectrumChannel::StartTx(), and ns3::SingleModelSpectrumChannel::StartTx().