ns3::YansWifiPhyHelper Class Reference

Make it easy to create and manage PHY objects for the yans model. More...

#include <yans-wifi-helper.h>

Inheritance diagram for ns3::YansWifiPhyHelper:

[legend]

Collaboration diagram for ns3::YansWifiPhyHelper:

[legend]

List of all members.

Public Types
enum	SupportedPcapDataLinkTypes { DLT_IEEE802_11 = PcapHelper::DLT_IEEE802_11, DLT_PRISM_HEADER = PcapHelper::DLT_PRISM_HEADER, DLT_IEEE802_11_RADIO = PcapHelper::DLT_IEEE802_11_RADIO }
Public Member Functions
	YansWifiPhyHelper ()
void	SetChannel (Ptr< YansWifiChannel > channel)
void	SetChannel (std::string channelName)
void	Set (std::string name, const AttributeValue &v)
void	SetErrorRateModel (std::string name, 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	SetPcapDataLinkType (enum SupportedPcapDataLinkTypes dlt)
Static Public Member Functions
static YansWifiPhyHelper	Default (void)

---

Detailed Description

Make it easy to create and manage PHY objects for the yans model.

The yans PHY model is described in "Yet Another Network Simulator", http://cutebugs.net/files/wns2-yans.pdf

The Pcap and ascii traces generated by the EnableAscii and EnablePcap methods defined in this class correspond to PHY-level traces and come to us via WifiPhyHelper

---

Member Enumeration Documentation

enum ns3::YansWifiPhyHelper::SupportedPcapDataLinkTypes

An enumeration of the pcap data link types (DLTs) which this helper supports. See http://wiki.wireshark.org/Development/LibpcapFileFormat for more information on these formats.

Enumerator:

DLT_IEEE802_11	IEEE 802.11 Wireless LAN headers on packets
DLT_PRISM_HEADER	Include Prism monitor mode information
DLT_IEEE802_11_RADIO	Include Radiotap link layer information

---

Constructor & Destructor Documentation

ns3::YansWifiPhyHelper::YansWifiPhyHelper

(

)

Create a phy helper without any parameter set. The user must set them all to be able to call Install later.

---

Member Function Documentation

static YansWifiPhyHelper ns3::YansWifiPhyHelper::Default

(

void

)

[static]

Create a phy helper in a default working state.

void ns3::YansWifiPhyHelper::Set	(	std::string	name,
		const AttributeValue &	v
	)

Parameters:

	name	the name of the attribute to set
	v	the value of the attribute

Set an attribute of the underlying PHY object.

void ns3::YansWifiPhyHelper::SetChannel

(

std::string

channelName

)

Parameters:

channelName

The name of the channel to associate to this helper

Every PHY created by a call to Install is associated to this channel.

void ns3::YansWifiPhyHelper::SetChannel

(

Ptr< YansWifiChannel >

channel

)

Parameters:

channel

the channel to associate to this helper

Every PHY created by a call to Install is associated to this channel.

void ns3::YansWifiPhyHelper::SetErrorRateModel	(	std::string	name,
		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:

	name	the name of the error rate model to set.
	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

Set the error rate model and its attributes to use when Install is called.

void ns3::YansWifiPhyHelper::SetPcapDataLinkType

(

enum SupportedPcapDataLinkTypes

dlt

)

Set the data link type of PCAP traces to be used. This function has to be called before EnablePcap(), so that the header of the pcap file can be written correctly.

See also:

SupportedPcapDataLinkTypes

Parameters:

dlt

The data link type of the pcap file (and packets) to be used

---

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

• src/helper/yans-wifi-helper.h