ns3::YansWifiChannelHelper Class Reference

manage and create wifi channel objects for the yans model. More...

#include <yans-wifi-helper.h>

Collaboration diagram for ns3::YansWifiChannelHelper:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 YansWifiChannelHelper ()
void AddPropagationLoss (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 SetPropagationDelay (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())
Ptr< YansWifiChannelCreate (void) const

Static Public Member Functions

static YansWifiChannelHelper Default (void)


Detailed Description

manage and create wifi channel objects for the yans model.

The intent of this class is to make it easy to create a channel object which implements the yans channel model. The yans channel model is described in "Yet Another Network Simulator", http://cutebugs.net/files/wns2-yans.pdf


Constructor & Destructor Documentation

ns3::YansWifiChannelHelper::YansWifiChannelHelper (  ) 

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


Member Function Documentation

void ns3::YansWifiChannelHelper::AddPropagationLoss ( 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 model to add
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
Add a propagation loss model to the set of currently-configured loss models. This method is additive to allow you to construct complex propagation loss models such as a log distance + jakes model, etc.

Ptr<YansWifiChannel> ns3::YansWifiChannelHelper::Create ( void   )  const

Returns:
a new channel
Create a channel based on the configuration parameters set previously.

static YansWifiChannelHelper ns3::YansWifiChannelHelper::Default ( void   )  [static]

Create a channel helper in a default working state. By default, we create a channel model with a propagation delay equal to a constant, the speed of light, and a propagation loss based on a log distance model with a reference loss of 46.6777 dB at reference distance of 1m.

void ns3::YansWifiChannelHelper::SetPropagationDelay ( 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 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
Configure a propagation delay for this channel.


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