helps to create WifiNetDevice objects More...

#include <wifi-helper.h>

Collaboration diagram for ns3::WifiHelper:

Public Member Functions
	WifiHelper ()
int64_t	AssignStreams (NetDeviceContainer c, int64_t stream)
NetDeviceContainer	Install (const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer c) const
NetDeviceContainer	Install (const WifiPhyHelper &phy, const WifiMacHelper &mac, Ptr< Node > node) const
NetDeviceContainer	Install (const WifiPhyHelper &phy, const WifiMacHelper &mac, std::string nodeName) const
void	SetRemoteStationManager (std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
void	SetStandard (enum WifiPhyStandard standard)

Static Public Member Functions
static WifiHelper	Default (void)
static void	EnableLogComponents (void)

Private Attributes
enum WifiPhyStandard	m_standard
ObjectFactory	m_stationManager

Detailed Description

helps to create WifiNetDevice objects

This class can help to create a large set of similar WifiNetDevice objects and to configure a large set of their attributes during creation.

Definition at line 88 of file wifi-helper.h.

Constructor & Destructor Documentation

ns3::WifiHelper::WifiHelper ( )

Create a Wifi helper in an empty state: all its parameters must be set before calling ns3::WifiHelper::Install

Definition at line 54 of file wifi-helper.cc.

Member Function Documentation

int64_t ns3::WifiHelper::AssignStreams	(	NetDeviceContainer	c,
		int64_t	stream
	)

Assign a fixed random variable stream number to the random variables used by the Phy and Mac aspects of the Wifi models. Each device in container c has fixed stream numbers assigned to its random variables. The Wifi channel (e.g. propagation loss model) is excluded. Return the number of streams (possibly zero) that have been assigned. The Install() method should have previously been called by the user.

Parameters

c	NetDeviceContainer of the set of net devices for which the WifiNetDevice should be modified to use fixed streams
stream	first stream index to use

Returns: the number of stream indices assigned by this helper

Definition at line 172 of file wifi-helper.cc.

References ns3::DcaTxop::AssignStreams(), ns3::EdcaTxopN::AssignStreams(), ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and ns3::PointerValue::Get().

Referenced by ns3::aodv::Bug772ChainTest::CreateDevices(), ns3::aodv::ChainRegressionTest::CreateDevices(), and ns3::olsr::Bug780Test::CreateNodes().

Here is the call graph for this function:

Here is the caller graph for this function:

WifiHelper ns3::WifiHelper::Default ( void )

static

Returns: a new WifiHelper in a default state

The default state is defined as being an Adhoc MAC layer with an ARF rate control algorithm and both objects using their default attribute values. By default, configure MAC and PHY for 802.11a.

Definition at line 60 of file wifi-helper.cc.

References SetRemoteStationManager().

Referenced by ns3::aodv::Bug772ChainTest::CreateDevices(), ns3::aodv::ChainRegressionTest::CreateDevices(), ns3::olsr::TcRegressionTest::CreateNodes(), ns3::aodv::LoopbackTestCase::DoRun(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiHelper::EnableLogComponents ( void )

static

Helper to enable all WifiNetDevice log components with one statement

Definition at line 137 of file wifi-helper.cc.

References ns3::LOG_LEVEL_ALL, and ns3::LogComponentEnable().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

NetDeviceContainer ns3::WifiHelper::Install	(	const WifiPhyHelper &	phy,
		const WifiMacHelper &	mac,
		NodeContainer	c
	)		const

Parameters

phy	the PHY helper to create PHY objects
mac	the MAC helper to create MAC objects
c	the set of nodes on which a wifi device must be created

Returns: a device container which contains all the devices created by this method.

Definition at line 97 of file wifi-helper.cc.

References ns3::NetDeviceContainer::Add(), ns3::Node::AddDevice(), ns3::Mac48Address::Allocate(), ns3::NodeContainer::Begin(), ns3::WifiPhy::ConfigureStandard(), ns3::WifiPhyHelper::Create(), ns3::ObjectFactory::Create(), ns3::WifiMacHelper::Create(), first::devices, ns3::NodeContainer::End(), ns3::Object::GetObject(), m_standard, m_stationManager, and NS_LOG_DEBUG.

Referenced by BatteryLifetimeTest::ConstantLoadTest(), ns3::aodv::Bug772ChainTest::CreateDevices(), AodvExample::CreateDevices(), DsdvManetExample::CreateDevices(), ns3::aodv::ChainRegressionTest::CreateDevices(), ns3::olsr::Bug780Test::CreateNodes(), ns3::olsr::TcRegressionTest::CreateNodes(), BasicEnergyDepletionTest::DepletionTestCase(), ns3::aodv::LoopbackTestCase::DoRun(), WifiMsduAggregatorThroughputTest::DoRun(), experiment(), Install(), main(), Experiment::Run(), RoutingExperiment::Run(), BatteryLifetimeTest::VariableLoadTest(), and WifiInterferenceTestCase::WifiSimpleInterference().

Here is the call graph for this function:

Here is the caller graph for this function:

NetDeviceContainer ns3::WifiHelper::Install	(	const WifiPhyHelper &	phy,
		const WifiMacHelper &	mac,
		Ptr< Node >	node
	)		const

Parameters

phy	the PHY helper to create PHY objects
mac	the MAC helper to create MAC objects
node	the node on which a wifi device must be created

Returns: a device container which contains all the devices created by this method.

Definition at line 122 of file wifi-helper.cc.

References Install().

Here is the call graph for this function:

NetDeviceContainer ns3::WifiHelper::Install	(	const WifiPhyHelper &	phy,
		const WifiMacHelper &	mac,
		std::string	nodeName
	)		const

Parameters

phy	the PHY helper to create PHY objects
mac	the MAC helper to create MAC objects
nodeName	the name of node on which a wifi device must be created

Returns: a device container which contains all the devices created by this method.

Definition at line 129 of file wifi-helper.cc.

References Install().

Here is the call graph for this function:

void ns3::WifiHelper::SetRemoteStationManager	(	std::string	type,
		std::string	n0 = `""`,
		const AttributeValue &	v0 = `EmptyAttributeValue ()`,
		std::string	n1 = `""`,
		const AttributeValue &	v1 = `EmptyAttributeValue ()`,
		std::string	n2 = `""`,
		const AttributeValue &	v2 = `EmptyAttributeValue ()`,
		std::string	n3 = `""`,
		const AttributeValue &	v3 = `EmptyAttributeValue ()`,
		std::string	n4 = `""`,
		const AttributeValue &	v4 = `EmptyAttributeValue ()`,
		std::string	n5 = `""`,
		const AttributeValue &	v5 = `EmptyAttributeValue ()`,
		std::string	n6 = `""`,
		const AttributeValue &	v6 = `EmptyAttributeValue ()`,
		std::string	n7 = `""`,
		const AttributeValue &	v7 = `EmptyAttributeValue ()`
	)

Parameters

type	the type of ns3::WifiRemoteStationManager to create.
n0	the name of the attribute to set
v0	the value of the attribute to set
n1	the name of the attribute to set
v1	the value of the attribute to set
n2	the name of the attribute to set
v2	the value of the attribute to set
n3	the name of the attribute to set
v3	the value of the attribute to set
n4	the name of the attribute to set
v4	the value of the attribute to set
n5	the name of the attribute to set
v5	the value of the attribute to set
n6	the name of the attribute to set
v6	the value of the attribute to set
n7	the name of the attribute to set
v7	the value of the attribute to set