a channel to interconnect ns3::YansWifiPhy objects. More...

#include "yans-wifi-channel.h"

Inheritance diagram for ns3::YansWifiChannel:

Collaboration diagram for ns3::YansWifiChannel:

Public Member Functions
	YansWifiChannel ()

	~YansWifiChannel () override

void	Add (Ptr< YansWifiPhy > phy)
	Adds the given YansWifiPhy to the PHY list. More...

int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model. More...

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

std::size_t	GetNDevices () const override

void	Send (Ptr< YansWifiPhy > sender, Ptr< const WifiPpdu > ppdu, double txPowerDbm) const

void	SetPropagationDelayModel (const Ptr< PropagationDelayModel > delay)

void	SetPropagationLossModel (const Ptr< PropagationLossModel > loss)

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

	~Channel () override

uint32_t	GetId () const

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

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

SimpleRefCount &	operator= (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...

Private Types
typedef std::vector< Ptr< YansWifiPhy > >	PhyList
	A vector of pointers to YansWifiPhy. More...

Static Private Member Functions
static void	Receive (Ptr< YansWifiPhy > receiver, Ptr< const WifiPpdu > ppdu, double txPowerDbm)
	This method is scheduled by Send for each associated YansWifiPhy. More...

Private Attributes
Ptr< PropagationDelayModel >	m_delay
	Propagation delay model. More...

Ptr< PropagationLossModel >	m_loss
	Propagation loss model. More...

PhyList	m_phyList
	List of YansWifiPhys connected to this YansWifiChannel. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoDispose ()
	Destructor implementation. 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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

a channel to interconnect ns3::YansWifiPhy objects.

This class is expected to be used in tandem with the ns3::YansWifiPhy class and supports an ns3::PropagationLossModel and an ns3::PropagationDelayModel. By default, no propagation models are set; it is the caller's responsibility to set them before using the channel.

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/PhyEntities/[i]/Channel/$ns3::YansWifiChannel"
"/ChannelList/[i]/$ns3::YansWifiChannel"

Attributes

PropagationDelayModel: A pointer to the propagation delay model attached to this channel.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::PropagationDelayModel>
- Initial value: 0
- Flags: constructwriteread
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: constructwriteread

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.
Size of this type is 72 bytes (on a 64-bit architecture).

Definition at line 45 of file yans-wifi-channel.h.

Member Typedef Documentation

◆ PhyList

typedef std::vector<Ptr<YansWifiPhy> > ns3::YansWifiChannel::PhyList

private

A vector of pointers to YansWifiPhy.

Definition at line 103 of file yans-wifi-channel.h.

Constructor & Destructor Documentation

◆ YansWifiChannel()

ns3::YansWifiChannel::YansWifiChannel ( )

Definition at line 64 of file yans-wifi-channel.cc.

References NS_LOG_FUNCTION.

◆ ~YansWifiChannel()

ns3::YansWifiChannel::~YansWifiChannel ( )

override

Definition at line 69 of file yans-wifi-channel.cc.

References m_phyList, and NS_LOG_FUNCTION.

Member Function Documentation

◆ Add()

void ns3::YansWifiChannel::Add ( Ptr< YansWifiPhy > phy )

Adds the given YansWifiPhy to the PHY list.

Parameters

phy	the YansWifiPhy to be added to the PHY list

Definition at line 165 of file yans-wifi-channel.cc.

References m_phyList, NS_LOG_FUNCTION, and third::phy.

◆ AssignStreams()

int64_t ns3::YansWifiChannel::AssignStreams ( int64_t stream )

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Definition at line 172 of file yans-wifi-channel.cc.

References ns3::PropagationLossModel::AssignStreams(), m_loss, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetDevice()

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

overridevirtual

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 159 of file yans-wifi-channel.cc.

References m_phyList.

◆ GetNDevices()

std::size_t ns3::YansWifiChannel::GetNDevices ( ) const

overridevirtual

Returns: the number of NetDevices connected to this Channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Definition at line 153 of file yans-wifi-channel.cc.

References m_phyList.

◆ GetTypeId()

TypeId ns3::YansWifiChannel::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 44 of file yans-wifi-channel.cc.

References m_delay, m_loss, ns3::MakePointerAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Receive()

void ns3::YansWifiChannel::Receive	(	Ptr< YansWifiPhy >	receiver,
		Ptr< const WifiPpdu >	ppdu,
		double	txPowerDbm
	)

staticprivate

This method is scheduled by Send for each associated YansWifiPhy.

The method then calls the corresponding YansWifiPhy that the first bit of the PPDU has arrived.

Parameters

receiver	the device to which the packet is destined
ppdu	the PPDU being sent
txPowerDbm	the TX power associated to the packet being sent (dBm)

Definition at line 134 of file yans-wifi-channel.cc.

References ns3::DbmToW(), NS_LOG_FUNCTION, NS_LOG_INFO, third::phy, and ns3::RatioToDb().

Referenced by Send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Send()

void ns3::YansWifiChannel::Send	(	Ptr< YansWifiPhy >	sender,
		Ptr< const WifiPpdu >	ppdu,
		double	txPowerDbm
	)		const

Parameters

sender	the PHY object from which the packet is originating.
ppdu	the PPDU to send
txPowerDbm	the TX power associated to the packet, in dBm

This method should not be invoked by normal users. It is currently invoked only from YansWifiPhy::StartTx. The channel attempts to deliver the PPDU to all other YansWifiPhy objects on the channel (except for the sender).

Definition at line 90 of file yans-wifi-channel.cc.

References ns3::PropagationLossModel::CalcRxPower(), ns3::WifiPhy::GetChannelNumber(), ns3::MobilityModel::GetDistanceFrom(), ns3::WifiPhy::GetMobility(), ns3::Object::GetObject(), m_delay, m_loss, m_phyList, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, Receive(), and ns3::Simulator::ScheduleWithContext().

Here is the call graph for this function:

◆ SetPropagationDelayModel()

void ns3::YansWifiChannel::SetPropagationDelayModel ( const Ptr< PropagationDelayModel > delay )

Parameters

delay the new propagation delay model.

Definition at line 83 of file yans-wifi-channel.cc.

References m_delay, and NS_LOG_FUNCTION.

◆ SetPropagationLossModel()

void ns3::YansWifiChannel::SetPropagationLossModel ( const Ptr< PropagationLossModel > loss )

Parameters

loss	the new propagation loss model.

Definition at line 76 of file yans-wifi-channel.cc.

References m_loss, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_delay

Ptr<PropagationDelayModel> ns3::YansWifiChannel::m_delay

private

Propagation delay model.

Definition at line 118 of file yans-wifi-channel.h.

Referenced by GetTypeId(), Send(), and SetPropagationDelayModel().

◆ m_loss

Ptr<PropagationLossModel> ns3::YansWifiChannel::m_loss

private

Propagation loss model.

Definition at line 117 of file yans-wifi-channel.h.

Referenced by AssignStreams(), GetTypeId(), Send(), and SetPropagationLossModel().

◆ m_phyList

PhyList ns3::YansWifiChannel::m_phyList

private

List of YansWifiPhys connected to this YansWifiChannel.

Definition at line 116 of file yans-wifi-channel.h.

Referenced by ~YansWifiChannel(), Add(), GetDevice(), GetNDevices(), and Send().

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

src/wifi/model/yans-wifi-channel.h
src/wifi/model/yans-wifi-channel.cc

Public Member Functions

Static Public Member Functions

Private Types

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Channel

Member Typedef Documentation

◆ PhyList

Constructor & Destructor Documentation

◆ YansWifiChannel()

◆ ~YansWifiChannel()

Member Function Documentation

◆ Add()

◆ AssignStreams()

◆ GetDevice()

◆ GetNDevices()

◆ GetTypeId()

◆ Receive()

◆ Send()

◆ SetPropagationDelayModel()

◆ SetPropagationLossModel()

Member Data Documentation

◆ m_delay

◆ m_loss

◆ m_phyList