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, enum mpduType mpdutype, Time duration) 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 ()
	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
	Implement the GetInstanceTypeId method defined in ObjectBase. 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...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. 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
	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)

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, struct Parameters parameters) 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)
	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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. 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:

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel"
"/ChannelList/[i]/$ns3::YansWifiChannel"
"/ChannelList/[i]/$ns3::WifiChannel/$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.
Size of this type is 72 bytes (on a 64-bit architecture).

Definition at line 61 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 122 of file yans-wifi-channel.h.

Constructor & Destructor Documentation

ns3::YansWifiChannel::YansWifiChannel ( )

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

ns3::YansWifiChannel::~YansWifiChannel ( )

virtual

Definition at line 62 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 147 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 153 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 141 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 135 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, ns3::MakePointerAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::YansWifiChannel::Receive	(	uint32_t	i,
		Ptr< Packet >	packet,
		struct Parameters	parameters
	)		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
atts	a vector containing the received power in dBm and the packet type
txVector	the TXVECTOR of the packet
preamble	the type of preamble being used to send the packet

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

References ns3::Parameters::duration, m_phyList, ns3::Parameters::preamble, ns3::Parameters::rxPowerDbm, ns3::Parameters::txVector, and ns3::Parameters::type.

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,
		enum mpduType	mpdutype,
		Time	duration
	)		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
mpdutype	the type of the MPDU as defined in WifiPhy::mpduType.
duration	the transmission duration 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 81 of file yans-wifi-channel.cc.

References ns3::PropagationLossModel::CalcRxPower(), ns3::Packet::Copy(), ns3::Parameters::duration, ns3::YansWifiPhy::GetChannelNumber(), ns3::MobilityModel::GetDistanceFrom(), ns3::YansWifiPhy::GetMobility(), ns3::Object::GetObject(), m_delay, m_loss, m_phyList, NS_ASSERT, NS_LOG_DEBUG, ns3::Parameters::preamble, Receive(), ns3::Parameters::rxPowerDbm, ns3::Simulator::ScheduleWithContext(), ns3::Parameters::txVector, and ns3::Parameters::type.

Here is the call graph for this function:

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

Parameters

delay the new propagation delay model.

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

References m_delay.

Referenced by InterferenceHelperSequenceTest::DoRun(), Bug555TestCase::DoRun(), experiment(), PsrExperiment::Run(), InterferenceExperiment::Run(), CollisionExperiment::Run(), and WifiTest::RunOne().

Here is the caller graph for this function:

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

Parameters

loss	the new propagation loss model.

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

References m_loss.

Referenced by InterferenceHelperSequenceTest::DoRun(), Bug555TestCase::DoRun(), experiment(), PsrExperiment::Run(), InterferenceExperiment::Run(), CollisionExperiment::Run(), and WifiTest::RunOne().

Here is the caller graph for this function:

Member Data Documentation

Ptr<PropagationDelayModel> ns3::YansWifiChannel::m_delay

private

Propagation delay model.

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

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

Ptr<PropagationLossModel> ns3::YansWifiChannel::m_loss

private

Propagation loss model.

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

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

PhyList ns3::YansWifiChannel::m_phyList

private

List of YansWifiPhys connected to this YansWifiChannel.

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

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

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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Channel

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation