A Discrete-Event Network Simulator
API
ns3::YansWifiChannel Class Reference

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 ()
 
virtual ~YansWifiChannel ()
 
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...
 
virtual Ptr< NetDeviceGetDevice (std::size_t i) const
 
virtual std::size_t GetNDevices (void) const
 
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 ()
 
virtual ~Channel ()
 
uint32_t GetId (void) const
 
- 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated 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 () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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::Channel
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 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< WifiPpdu > ppdu, double txPowerDbm)
 This method is scheduled by Send for each associated YansWifiPhy. More...
 

Private Attributes

Ptr< PropagationDelayModelm_delay
 Propagation delay model. More...
 
Ptr< PropagationLossModelm_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 (void)
 Destructor implementation. 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...
 

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::WaveNetDevice/Channel/$ns3::YansWifiChannel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel"

Attributes

Attributes defined in parent class ns3::Channel

  • Id: The id (unique integer) of this Channel.

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 105 of file yans-wifi-channel.h.

Constructor & Destructor Documentation

◆ YansWifiChannel()

ns3::YansWifiChannel::YansWifiChannel ( )

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

References NS_LOG_FUNCTION.

◆ ~YansWifiChannel()

ns3::YansWifiChannel::~YansWifiChannel ( )
virtual

Definition at line 65 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
phythe YansWifiPhy to be added to the PHY list

Definition at line 154 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
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 161 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
virtual
Parameters
iindex 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 148 of file yans-wifi-channel.cc.

References m_phyList.

◆ GetNDevices()

std::size_t ns3::YansWifiChannel::GetNDevices ( void  ) const
virtual
Returns
the number of NetDevices connected to this Channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

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

References m_phyList.

◆ GetTypeId()

TypeId ns3::YansWifiChannel::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 42 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< 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
receiverthe device to which the packet is destined
ppduthe PPDU being sent
txPowerDbmthe TX power associated to the packet being sent (dBm)

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

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

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
senderthe PHY object from which the packet is originating.
ppduthe PPDU to send
txPowerDbmthe 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 86 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
delaythe new propagation delay model.

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

References m_delay, and NS_LOG_FUNCTION.

Referenced by experiment().

+ Here is the caller graph for this function:

◆ SetPropagationLossModel()

void ns3::YansWifiChannel::SetPropagationLossModel ( const Ptr< PropagationLossModel loss)
Parameters
lossthe new propagation loss model.

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

References m_loss, and NS_LOG_FUNCTION.

Referenced by experiment().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_delay

Ptr<PropagationDelayModel> ns3::YansWifiChannel::m_delay
private

Propagation delay model.

Definition at line 120 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 119 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 118 of file yans-wifi-channel.h.

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


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