ns3::MeshHelper Class Reference

Helper to create IEEE 802.11s mesh networks. More...

#include <mesh-helper.h>

List of all members.

Public Types
enum	ChannelPolicy { SPREAD_CHANNELS, ZERO_CHANNEL }
	Spread/not spread frequency channels of MP interfaces. More...
Public Member Functions
	MeshHelper ()
	~MeshHelper ()
void	SetMacType (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	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)
void	SetSpreadInterfaceChannels (ChannelPolicy)
	set the channel policy
void	SetNumberOfInterfaces (uint32_t nInterfaces)
	Set a number of interfaces in a mesh network.
NetDeviceContainer	Install (const WifiPhyHelper &phyHelper, NodeContainer c) const
	Install 802.11s mesh device & protocols on given node list.
void	SetStackInstaller (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	Report (const ns3::Ptr< ns3::NetDevice > &, std::ostream &)
	Print statistics.
void	ResetStats (const ns3::Ptr< ns3::NetDevice > &)
	Reset statistics.
Static Public Member Functions
static MeshHelper	Default ()
	Set the helper to the default values for the MAC type, remote station manager and channel policy.

---

Detailed Description

Helper to create IEEE 802.11s mesh networks.

---

Member Enumeration Documentation

enum ns3::MeshHelper::ChannelPolicy

Spread/not spread frequency channels of MP interfaces.

If set to true different non-overlapping 20MHz frequency channels will be assigned to different mesh point interfaces.

---

Constructor & Destructor Documentation

ns3::MeshHelper::MeshHelper

(

)

Construct a MeshHelper used to make life easier when creating 802.11s networks.

ns3::MeshHelper::~MeshHelper

(

)

Destroy a MeshHelper.

---

Member Function Documentation

NetDeviceContainer ns3::MeshHelper::Install	(	const WifiPhyHelper &	phyHelper,
		NodeContainer	c
	)		const

Install 802.11s mesh device & protocols on given node list.

Parameters:

phyHelper	Wifi PHY helper
c	List of nodes to install

Returns:

list of created mesh point devices, see MeshPointDevice

References ns3::NetDeviceContainer::Add(), ns3::Node::AddDevice(), ns3::MeshPointDevice::AddInterface(), ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), ns3::MeshStack::InstallStack(), NS_ASSERT, and NS_FATAL_ERROR.

void ns3::MeshHelper::SetMacType	(	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:

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

References ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().

Referenced by Default().

void ns3::MeshHelper::SetNumberOfInterfaces

(

uint32_t

nInterfaces

)

Set a number of interfaces in a mesh network.

Parameters:

nInterfaces

is the number of interfaces

void ns3::MeshHelper::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.

References ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().

Referenced by Default().

void ns3::MeshHelper::SetStackInstaller	(	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::MeshStack.
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

References ns3::ObjectFactory::Create(), NS_FATAL_ERROR, ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().

void ns3::MeshHelper::SetStandard

(

enum WifiPhyStandard

standard

)

Set PHY standard

---

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

• src/mesh/helper/mesh-helper.h
• src/mesh/helper/mesh-helper.cc