A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::WifiSpectrumPhyInterface Class Reference

This class is an adaptor between class SpectrumWifiPhy (which inherits from WifiPhy) and class SpectrumChannel (which expects objects derived from class SpectrumPhy to be connected to it). More...

#include "wifi-spectrum-phy-interface.h"

+ Inheritance diagram for ns3::WifiSpectrumPhyInterface:
+ Collaboration diagram for ns3::WifiSpectrumPhyInterface:

Public Member Functions

 WifiSpectrumPhyInterface (FrequencyRange freqRange)
 Constructor.
 
Ptr< ObjectGetAntenna () const override
 Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception.
 
const WifiSpectrumBandsGetBands () const
 Get the vector of spectrum bands handled by this interface.
 
const std::vector< MHz_u > & GetCenterFrequencies () const
 Get the center frequency for each segment of the the spectrum channel this interface is attached to.
 
Ptr< SpectrumChannelGetChannel () const
 Get the spectrum channel this interface is attached to.
 
MHz_u GetChannelWidth () const
 Get the channel width covered by the spectrum channel this interface is attached to.
 
Ptr< NetDeviceGetDevice () const override
 Get the associated NetDevice instance.
 
const FrequencyRangeGetFrequencyRange () const
 Get the frequency range covered by the spectrum channel this interface is attached to.
 
const HeRuBandsGetHeRuBands () const
 Get the HE RU spectrum bands handled by this interface.
 
Ptr< MobilityModelGetMobility () const override
 Get the associated MobilityModel instance.
 
Ptr< const SpectrumModelGetRxSpectrumModel () const override
 
Ptr< const SpectrumWifiPhyGetSpectrumWifiPhy () const
 Get SpectrumWifiPhy object.
 
void SetBands (WifiSpectrumBands &&bands)
 Set the vector of spectrum bands handled by this interface.
 
void SetChannel (const Ptr< SpectrumChannel > c) override
 Set the channel attached to this device.
 
void SetDevice (const Ptr< NetDevice > d) override
 Set the associated NetDevice instance.
 
void SetHeRuBands (HeRuBands &&heRuBands)
 Set the HE RU spectrum bands handled by this interface (if any)
 
void SetMobility (const Ptr< MobilityModel > m) override
 Set the mobility model associated with this device.
 
void SetRxSpectrumModel (const std::vector< MHz_u > &centerFrequencies, MHz_u channelWidth, Hz_u bandBandwidth, MHz_u guardBandwidth)
 Set the RX spectrum model.
 
void SetSpectrumWifiPhy (const Ptr< SpectrumWifiPhy > phy)
 Connect SpectrumWifiPhy object.
 
void StartRx (Ptr< SpectrumSignalParameters > params) override
 Notify the SpectrumPhy instance of an incoming signal.
 
void StartTx (Ptr< SpectrumSignalParameters > params)
 Start transmission over the spectrum channel.
 
- Public Member Functions inherited from ns3::SpectrumPhy
 SpectrumPhy ()
 
 SpectrumPhy (const SpectrumPhy &)=delete
 
 ~SpectrumPhy () override
 
SpectrumPhyoperator= (const SpectrumPhy &)=delete
 
- 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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::SpectrumPhy
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.
 

Private Member Functions

void DoDispose () override
 Destructor implementation.
 

Private Attributes

WifiSpectrumBands m_bands
 Store all the distinct spectrum bands associated with every channels widths.
 
std::vector< MHz_um_centerFrequencies
 center frequency per segment
 
Ptr< SpectrumChannelm_channel
 spectrum channel
 
MHz_u m_channelWidth
 channel width
 
FrequencyRange m_frequencyRange
 frequency range
 
HeRuBands m_heRuBands
 Store all the distinct spectrum bands associated with every RU.
 
Ptr< NetDevicem_netDevice
 the device
 
Ptr< const SpectrumModelm_rxSpectrumModel
 receive spectrum model
 
Ptr< SpectrumWifiPhym_spectrumWifiPhy
 spectrum PHY
 

Additional Inherited Members

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

Detailed Description

This class is an adaptor between class SpectrumWifiPhy (which inherits from WifiPhy) and class SpectrumChannel (which expects objects derived from class SpectrumPhy to be connected to it).

The adaptor is used only in the receive direction; in the transmit direction, the class SpectrumWifiPhy constructs signal parameters and directly accesses the SpectrumChannel

Definition at line 35 of file wifi-spectrum-phy-interface.h.

Constructor & Destructor Documentation

◆ WifiSpectrumPhyInterface()

ns3::WifiSpectrumPhyInterface::WifiSpectrumPhyInterface ( FrequencyRange freqRange)

Constructor.

Parameters
freqRangethe frequency range covered by the interface

Definition at line 34 of file wifi-spectrum-phy-interface.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::WifiSpectrumPhyInterface::DoDispose ( )
overrideprivatevirtual

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 45 of file wifi-spectrum-phy-interface.cc.

References m_bands, m_channel, m_heRuBands, m_netDevice, m_rxSpectrumModel, m_spectrumWifiPhy, and NS_LOG_FUNCTION.

◆ GetAntenna()

Ptr< Object > ns3::WifiSpectrumPhyInterface::GetAntenna ( ) const
overridevirtual

Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception.

Note that in general and depending on each module design, there can be multiple SpectrumPhy instances per NetDevice.

Returns
a Ptr to the AntennaModel used by this SpectrumPhy instance for transmission and/or reception

Implements ns3::SpectrumPhy.

Definition at line 133 of file wifi-spectrum-phy-interface.cc.

References m_spectrumWifiPhy.

◆ GetBands()

const WifiSpectrumBands & ns3::WifiSpectrumPhyInterface::GetBands ( ) const

Get the vector of spectrum bands handled by this interface.

Returns
the vector of spectrum bands

Definition at line 163 of file wifi-spectrum-phy-interface.cc.

References m_bands.

◆ GetCenterFrequencies()

const std::vector< MHz_u > & ns3::WifiSpectrumPhyInterface::GetCenterFrequencies ( ) const

Get the center frequency for each segment of the the spectrum channel this interface is attached to.

Returns
the center frequency for each segment of the the spectrum channel this interface is attached to to

Definition at line 145 of file wifi-spectrum-phy-interface.cc.

References m_centerFrequencies.

◆ GetChannel()

Ptr< SpectrumChannel > ns3::WifiSpectrumPhyInterface::GetChannel ( ) const

Get the spectrum channel this interface is attached to.

Returns
the spectrum channel this interface is attached to

Definition at line 121 of file wifi-spectrum-phy-interface.cc.

References m_channel.

◆ GetChannelWidth()

MHz_u ns3::WifiSpectrumPhyInterface::GetChannelWidth ( ) const

Get the channel width covered by the spectrum channel this interface is attached to.

Returns
the channel width covered by the spectrum channel this interface is attached to to

Definition at line 151 of file wifi-spectrum-phy-interface.cc.

References m_channelWidth.

◆ GetDevice()

Ptr< NetDevice > ns3::WifiSpectrumPhyInterface::GetDevice ( ) const
overridevirtual

Get the associated NetDevice instance.

Returns
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

Definition at line 69 of file wifi-spectrum-phy-interface.cc.

References m_netDevice.

◆ GetFrequencyRange()

const FrequencyRange & ns3::WifiSpectrumPhyInterface::GetFrequencyRange ( ) const

Get the frequency range covered by the spectrum channel this interface is attached to.

Returns
the frequency range covered by the spectrum channel this interface is attached to

Definition at line 139 of file wifi-spectrum-phy-interface.cc.

References m_frequencyRange.

◆ GetHeRuBands()

const HeRuBands & ns3::WifiSpectrumPhyInterface::GetHeRuBands ( ) const

Get the HE RU spectrum bands handled by this interface.

Returns
the HE RU spectrum bands

Definition at line 175 of file wifi-spectrum-phy-interface.cc.

References m_heRuBands.

◆ GetMobility()

Ptr< MobilityModel > ns3::WifiSpectrumPhyInterface::GetMobility ( ) const
overridevirtual

Get the associated MobilityModel instance.

Returns
a Ptr to the associated MobilityModel instance

Implements ns3::SpectrumPhy.

Definition at line 75 of file wifi-spectrum-phy-interface.cc.

References m_spectrumWifiPhy.

◆ GetRxSpectrumModel()

Ptr< const SpectrumModel > ns3::WifiSpectrumPhyInterface::GetRxSpectrumModel ( ) const
overridevirtual
Returns
returns the SpectrumModel that this SpectrumPhy expects to be used for all SpectrumValues that are passed to StartRx. If 0 is returned, it means that any model will be accepted.

Implements ns3::SpectrumPhy.

Definition at line 127 of file wifi-spectrum-phy-interface.cc.

References m_rxSpectrumModel.

◆ GetSpectrumWifiPhy()

Ptr< const SpectrumWifiPhy > ns3::WifiSpectrumPhyInterface::GetSpectrumWifiPhy ( ) const

Get SpectrumWifiPhy object.

Returns
Pointer to SpectrumWifiPhy object

Definition at line 63 of file wifi-spectrum-phy-interface.cc.

References m_spectrumWifiPhy.

◆ GetTypeId()

TypeId ns3::WifiSpectrumPhyInterface::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 27 of file wifi-spectrum-phy-interface.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetBands()

void ns3::WifiSpectrumPhyInterface::SetBands ( WifiSpectrumBands && bands)

Set the vector of spectrum bands handled by this interface.

Parameters
bandsvector of spectrum bands

Definition at line 157 of file wifi-spectrum-phy-interface.cc.

References m_bands.

◆ SetChannel()

void ns3::WifiSpectrumPhyInterface::SetChannel ( const Ptr< SpectrumChannel > c)
overridevirtual

Set the channel attached to this device.

Parameters
cthe channel

Implements ns3::SpectrumPhy.

Definition at line 93 of file wifi-spectrum-phy-interface.cc.

References m_channel, m_rxSpectrumModel, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ SetDevice()

void ns3::WifiSpectrumPhyInterface::SetDevice ( const Ptr< NetDevice > d)
overridevirtual

Set the associated NetDevice instance.

Parameters
dthe NetDevice instance

Implements ns3::SpectrumPhy.

Definition at line 81 of file wifi-spectrum-phy-interface.cc.

References m_netDevice.

◆ SetHeRuBands()

void ns3::WifiSpectrumPhyInterface::SetHeRuBands ( HeRuBands && heRuBands)

Set the HE RU spectrum bands handled by this interface (if any)

Parameters
heRuBandsthe HE RU spectrum bands

Definition at line 169 of file wifi-spectrum-phy-interface.cc.

References m_heRuBands.

◆ SetMobility()

void ns3::WifiSpectrumPhyInterface::SetMobility ( const Ptr< MobilityModel > m)
overridevirtual

Set the mobility model associated with this device.

Parameters
mthe mobility model

Implements ns3::SpectrumPhy.

Definition at line 87 of file wifi-spectrum-phy-interface.cc.

References m_spectrumWifiPhy.

◆ SetRxSpectrumModel()

void ns3::WifiSpectrumPhyInterface::SetRxSpectrumModel ( const std::vector< MHz_u > & centerFrequencies,
MHz_u channelWidth,
Hz_u bandBandwidth,
MHz_u guardBandwidth )

Set the RX spectrum model.

Parameters
centerFrequenciesthe center frequency for each segment
channelWidththe total channel width
bandBandwidththe width of each band
guardBandwidththe total width of the guard band

Definition at line 101 of file wifi-spectrum-phy-interface.cc.

References ns3::WifiSpectrumValueHelper::GetSpectrumModel(), m_centerFrequencies, m_channelWidth, m_rxSpectrumModel, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SetSpectrumWifiPhy()

void ns3::WifiSpectrumPhyInterface::SetSpectrumWifiPhy ( const Ptr< SpectrumWifiPhy > phy)

Connect SpectrumWifiPhy object.

Parameters
phySpectrumWifiPhy object to be connected to this object

Definition at line 57 of file wifi-spectrum-phy-interface.cc.

References m_spectrumWifiPhy.

◆ StartRx()

void ns3::WifiSpectrumPhyInterface::StartRx ( Ptr< SpectrumSignalParameters > params)
overridevirtual

Notify the SpectrumPhy instance of an incoming signal.

Parameters
paramsthe parameters of the signals being received

Implements ns3::SpectrumPhy.

Definition at line 181 of file wifi-spectrum-phy-interface.cc.

References m_spectrumWifiPhy.

◆ StartTx()

void ns3::WifiSpectrumPhyInterface::StartTx ( Ptr< SpectrumSignalParameters > params)

Start transmission over the spectrum channel.

Parameters
paramsthe parameters of the signal to transmit

Definition at line 187 of file wifi-spectrum-phy-interface.cc.

References m_channel, and m_spectrumWifiPhy.

Member Data Documentation

◆ m_bands

WifiSpectrumBands ns3::WifiSpectrumPhyInterface::m_bands
private

Store all the distinct spectrum bands associated with every channels widths.

Definition at line 159 of file wifi-spectrum-phy-interface.h.

Referenced by DoDispose(), GetBands(), and SetBands().

◆ m_centerFrequencies

std::vector<MHz_u> ns3::WifiSpectrumPhyInterface::m_centerFrequencies
private

center frequency per segment

Definition at line 154 of file wifi-spectrum-phy-interface.h.

Referenced by GetCenterFrequencies(), and SetRxSpectrumModel().

◆ m_channel

Ptr<SpectrumChannel> ns3::WifiSpectrumPhyInterface::m_channel
private

spectrum channel

Definition at line 153 of file wifi-spectrum-phy-interface.h.

Referenced by DoDispose(), GetChannel(), SetChannel(), and StartTx().

◆ m_channelWidth

MHz_u ns3::WifiSpectrumPhyInterface::m_channelWidth
private

channel width

Definition at line 155 of file wifi-spectrum-phy-interface.h.

Referenced by GetChannelWidth(), and SetRxSpectrumModel().

◆ m_frequencyRange

FrequencyRange ns3::WifiSpectrumPhyInterface::m_frequencyRange
private

frequency range

Definition at line 150 of file wifi-spectrum-phy-interface.h.

Referenced by GetFrequencyRange().

◆ m_heRuBands

HeRuBands ns3::WifiSpectrumPhyInterface::m_heRuBands
private

Store all the distinct spectrum bands associated with every RU.

Definition at line 160 of file wifi-spectrum-phy-interface.h.

Referenced by DoDispose(), GetHeRuBands(), and SetHeRuBands().

◆ m_netDevice

Ptr<NetDevice> ns3::WifiSpectrumPhyInterface::m_netDevice
private

the device

Definition at line 152 of file wifi-spectrum-phy-interface.h.

Referenced by DoDispose(), GetDevice(), and SetDevice().

◆ m_rxSpectrumModel

Ptr<const SpectrumModel> ns3::WifiSpectrumPhyInterface::m_rxSpectrumModel
private

receive spectrum model

Definition at line 156 of file wifi-spectrum-phy-interface.h.

Referenced by DoDispose(), GetRxSpectrumModel(), SetChannel(), and SetRxSpectrumModel().

◆ m_spectrumWifiPhy

Ptr<SpectrumWifiPhy> ns3::WifiSpectrumPhyInterface::m_spectrumWifiPhy
private

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