NS-3
ns3::MeshHelper Class Reference

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

#include <mesh-helper.h>

Collaboration diagram for ns3::MeshHelper:

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

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:
phyHelperWifi PHY helper
cList of nodes to install
Returns:
list of created mesh point devices, see MeshPointDevice
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:
n0the name of the attribute to set
v0the value of the attribute to set
n1the name of the attribute to set
v1the value of the attribute to set
n2the name of the attribute to set
v2the value of the attribute to set
n3the name of the attribute to set
v3the value of the attribute to set
n4the name of the attribute to set
v4the value of the attribute to set
n5the name of the attribute to set
v5the value of the attribute to set
n6the name of the attribute to set
v6the value of the attribute to set
n7the name of the attribute to set
v7the value of the attribute to set

All the attributes specified in this method should exist in the requested mac.

void ns3::MeshHelper::SetNumberOfInterfaces ( uint32_t  nInterfaces)

Set a number of interfaces in a mesh network.

Parameters:
nInterfacesis 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:
typethe type of ns3::WifiRemoteStationManager to create.
n0the name of the attribute to set
v0the value of the attribute to set
n1the name of the attribute to set
v1the value of the attribute to set
n2the name of the attribute to set
v2the value of the attribute to set
n3the name of the attribute to set
v3the value of the attribute to set
n4the name of the attribute to set
v4the value of the attribute to set
n5the name of the attribute to set
v5the value of the attribute to set
n6the name of the attribute to set
v6the value of the attribute to set
n7the name of the attribute to set
v7the value of the attribute to set

All the attributes specified in this method should exist in the requested station manager.

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:
typethe type of ns3::MeshStack.
n0the name of the attribute to set
v0the value of the attribute to set
n1the name of the attribute to set
v1the value of the attribute to set
n2the name of the attribute to set
v2the value of the attribute to set
n3the name of the attribute to set
v3the value of the attribute to set
n4the name of the attribute to set
v4the value of the attribute to set
n5the name of the attribute to set
v5the value of the attribute to set
n6the name of the attribute to set
v6the value of the attribute to set
n7the name of the attribute to set
v7the value of the attribute to set
void ns3::MeshHelper::SetStandard ( enum WifiPhyStandard  standard)

Set PHY standard


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