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

Ptr< Object >	GetAntenna () const override
	Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception. More...

Ptr< NetDevice >	GetDevice () const override
	Get the associated NetDevice instance. More...

Ptr< MobilityModel >	GetMobility () const override
	Get the associated MobilityModel instance. More...

Ptr< const SpectrumModel >	GetRxSpectrumModel () const override

void	SetChannel (const Ptr< SpectrumChannel > c) override
	Set the channel attached to this device. More...

void	SetDevice (const Ptr< NetDevice > d) override
	Set the associated NetDevice instance. More...

void	SetMobility (const Ptr< MobilityModel > m) override
	Set the mobility model associated with this device. More...

void	SetSpectrumWifiPhy (const Ptr< SpectrumWifiPhy > phy)
	Connect SpectrumWifiPhy object. More...

void	StartRx (Ptr< SpectrumSignalParameters > params) override
	Notify the SpectrumPhy instance of an incoming signal. More...

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

	SpectrumPhy (SpectrumPhy const &)=delete

virtual	~SpectrumPhy ()

SpectrumPhy &	operator= (SpectrumPhy const &)=delete

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::SpectrumPhy
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
void	DoDispose (void) override
	Destructor implementation. More...

Private Attributes
Ptr< SpectrumChannel >	m_channel
	spectrum channel More...

Ptr< NetDevice >	m_netDevice
	the device More...

Ptr< SpectrumWifiPhy >	m_spectrumWifiPhy
	spectrum PHY 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

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

Introspection did not find any typical Config paths.

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

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 56 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ WifiSpectrumPhyInterface()

ns3::WifiSpectrumPhyInterface::WifiSpectrumPhyInterface ( )

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::WifiSpectrumPhyInterface::DoDispose ( void )

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

References m_channel, m_netDevice, 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 100 of file wifi-spectrum-phy-interface.cc.

References ns3::SpectrumWifiPhy::GetAntenna(), m_spectrumWifiPhy, and NS_LOG_FUNCTION.

Here is the call graph for this function:

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

References m_netDevice.

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

References ns3::WifiPhy::GetMobility(), and m_spectrumWifiPhy.

Here is the call graph for this function:

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

References ns3::SpectrumWifiPhy::GetRxSpectrumModel(), and m_spectrumWifiPhy.

Here is the call graph for this function: