ns3::YansWifiChannel Class Reference

A Yans wifi channelThis wifi channel implements the propagation model described in "Yet Another Network Simulator", (http://cutebugs.net/files/wns2-yans.pdf). More...

#include <yans-wifi-channel.h>

Inheritance diagram for ns3::YansWifiChannel:

Public Member Functions
void	Add (Ptr< YansWifiPhy > phy)
int64_t	AssignStreams (int64_t stream)
virtual Ptr< NetDevice >	GetDevice (uint32_t i) const
virtual uint32_t	GetNDevices (void) const
void	Send (Ptr< YansWifiPhy > sender, Ptr< const Packet > packet, double txPowerDbm, WifiMode wifiMode, WifiPreamble preamble) const
void	SetPropagationDelayModel (Ptr< PropagationDelayModel > delay)
void	SetPropagationLossModel (Ptr< PropagationLossModel > loss)
Public Member Functions inherited from ns3::Channel
uint32_t	GetId (void) const
Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Initialize (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::WifiChannel
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::Channel
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Private Types
typedef std::vector< Ptr < YansWifiPhy > >	PhyList

Private Member Functions
	YansWifiChannel (const YansWifiChannel &)
YansWifiChannel &	operator= (const YansWifiChannel &)
void	Receive (uint32_t i, Ptr< Packet > packet, double rxPowerDbm, WifiMode txMode, WifiPreamble preamble) const

Private Attributes
Ptr< PropagationDelayModel >	m_delay
Ptr< PropagationLossModel >	m_loss
PhyList	m_phyList

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoDispose (void)
virtual void	DoInitialize (void)
virtual void	NotifyNewAggregate (void)
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

Detailed Description

A Yans wifi channel

This wifi channel implements the propagation model described in "Yet Another Network Simulator", (http://cutebugs.net/files/wns2-yans.pdf).

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

Config Paths

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

• /ChannelList/[i]/$ns3::WifiChannel/$ns3::YansWifiChannel
• /ChannelList/[i]/$ns3::YansWifiChannel
• /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel

Attributes

• 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: construct write read
• 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: construct write read

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.

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

Member Function Documentation

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

References ns3::PropagationLossModel::AssignStreams().

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

virtual

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

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

void ns3::YansWifiChannel::Send	(	Ptr< YansWifiPhy >	sender,
		Ptr< const Packet >	packet,
		double	txPowerDbm,
		WifiMode	wifiMode,
		WifiPreamble	preamble
	)		const

Parameters

sender	the device from which the packet is originating.
packet	the packet to send
txPowerDbm	the tx power associated to the packet
wifiMode	the tx mode associated to the packet
preamble	the preamble associated to the packet

This method should not be invoked by normal users. It is currently invoked only from WifiPhy::Send. YansWifiChannel delivers packets only between PHYs with the same m_channelNumber, e.g. PHYs that are operating on the same channel.

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

References ns3::PropagationLossModel::CalcRxPower(), ns3::Packet::Copy(), ns3::YansWifiPhy::GetChannelNumber(), ns3::MobilityModel::GetDistanceFrom(), ns3::Object::GetObject(), NS_ASSERT, NS_LOG_DEBUG, and ns3::Simulator::ScheduleWithContext().

void ns3::YansWifiChannel::SetPropagationDelayModel

(

Ptr< PropagationDelayModel >

delay

)

Parameters

delay

the new propagation delay model.

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

void ns3::YansWifiChannel::SetPropagationLossModel

(

Ptr< PropagationLossModel >

loss

)

Parameters

loss	the new propagation loss model.

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

---

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