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:

Collaboration diagram for ns3::YansWifiChannel:

Public Member Functions
	YansWifiChannel ()
virtual	~YansWifiChannel ()
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)

Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::YansWifiChannel.

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	DoStart (void)
virtual void	NotifyNewAggregate (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.

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

Member Typedef Documentation

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

private

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

Constructor & Destructor Documentation

ns3::YansWifiChannel::YansWifiChannel ( )

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

ns3::YansWifiChannel::~YansWifiChannel ( )

virtual

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

References m_phyList, and NS_LOG_FUNCTION_NOARGS.

ns3::YansWifiChannel::YansWifiChannel ( const YansWifiChannel & )

private

Member Function Documentation

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

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

References m_phyList.

Referenced by ns3::YansWifiPhy::SetChannel().

Here is the caller graph for this function:

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(), and m_loss.

Referenced by ns3::YansWifiChannelHelper::AssignStreams().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

References m_phyList.

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.

References m_phyList.

TypeId ns3::YansWifiChannel::GetTypeId ( void )

static

This method returns the TypeId associated to ns3::YansWifiChannel.

This object is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes defined for this type:

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 defined for this type.

Reimplemented from ns3::WifiChannel.

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

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

Here is the call graph for this function:

YansWifiChannel& ns3::YansWifiChannel::operator= ( const YansWifiChannel & )

private

void ns3::YansWifiChannel::Receive	(	uint32_t	i,
		Ptr< Packet >	packet,
		double	rxPowerDbm,
		WifiMode	txMode,
		WifiPreamble	preamble
	)		const

private

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

References m_phyList.

Referenced by Send().

Here is the caller graph for this function:

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::PropagationDelayModel::GetDelay(), ns3::MobilityModel::GetDistanceFrom(), ns3::YansWifiPhy::GetMobility(), ns3::Object::GetObject(), m_delay, m_loss, m_phyList, NS_ASSERT, NS_LOG_DEBUG, Receive(), and ns3::Simulator::ScheduleWithContext().