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)
	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< NetDevice >	GetDevice (uint32_t i) const

virtual uint32_t	GetNDevices (void) const

void	Send (Ptr< YansWifiPhy > sender, Ptr< const Packet > packet, double txPowerDbm, WifiTxVector txVector, WifiPreamble preamble) const

void	SetPropagationDelayModel (Ptr< PropagationDelayModel > delay)

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

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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

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)
	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::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. 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...

Private Member Functions
void	Receive (uint32_t i, Ptr< Packet > packet, double rxPowerDbm, WifiTxVector txVector, WifiPreamble preamble) const
	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)

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

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

Member Typedef Documentation

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

private

A vector of pointers to YansWifiPhy.

Definition at line 110 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.

Member Function Documentation

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

References m_phyList.

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.

Here is the call 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

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:

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

private

This method is scheduled by Send for each associated YansWifiPhy.

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

Parameters

i	index of the corresponding YansWifiPhy in the PHY list
packet	the packet being sent
rxPowerDbm	the received power of the packet
txVector	the TXVECTOR of the packet
preamble	the type of preamble being used to send the packet

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,
		WifiTxVector	txVector,
		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
txVector	the TXVECTOR 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::YansWifiPhy::GetMobility(), ns3::Object::GetObject(), m_delay, m_loss, m_phyList, NS_ASSERT, NS_LOG_DEBUG, Receive(), and ns3::Simulator::ScheduleWithContext().