ns3::WifiHelper Class Reference

helps to create WifiNetDevice objects More...

#include <wifi-helper.h>

Collaboration diagram for ns3::WifiHelper:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 WifiHelper ()
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())
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

Static Public Member Functions

static WifiHelper Default (void)
static void EnableLogComponents (void)


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.


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


Member Function Documentation

static 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.

static void ns3::WifiHelper::EnableLogComponents ( void   )  [static]

Helper to enable all WifiNetDevice log components with one statement

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.

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.

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.

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
All the attributes specified in this method should exist in the requested station manager.


The documentation for this class was generated from the following file:

Generated on Fri Apr 9 15:01:10 2010 for NS-3 by  doxygen 1.5.8