ns3::UanHelper Class Reference

Collaboration diagram for ns3::UanHelper:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void SetMac (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 SetPhy (std::string phyType, 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 SetTransducer (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 (NodeContainer c) const
NetDeviceContainer Install (NodeContainer c, Ptr< UanChannel > channel) const
Ptr< UanNetDevice > Install (Ptr< Node > node, Ptr< UanChannel > channel) const

Static Public Member Functions

static void EnableAscii (std::ostream &os, uint32_t nodeid, uint32_t deviceid)
static void EnableAscii (std::ostream &os, NetDeviceContainer d)
static void EnableAscii (std::ostream &os, NodeContainer n)
static void EnableAsciiAll (std::ostream &os)

Member Function Documentation

static void ns3::UanHelper::EnableAscii ( std::ostream &  os,
NodeContainer  n 
) [static]
Parameters:
os output stream
n node container

Enable ascii output on each device which is of the ns3::WifiNetDevice type and which is located in one of the input node and dump that to the specified stdc++ output stream.

static void ns3::UanHelper::EnableAscii ( std::ostream &  os,
NetDeviceContainer  d 
) [static]
Parameters:
os output stream
d device container

Enable ascii output on each device which is of the ns3::WifiNetDevice type and which is located in the input device container and dump that to the specified stdc++ output stream.

static void ns3::UanHelper::EnableAscii ( std::ostream &  os,
uint32_t  nodeid,
uint32_t  deviceid 
) [static]
Parameters:
os output stream
nodeid the id of the node to generate ascii output for.
deviceid the id of the device to generate ascii output for.

Enable ascii output on the specified deviceid within the specified nodeid if it is of type ns3::WifiNetDevice and dump that to the specified stdc++ output stream.

static void ns3::UanHelper::EnableAsciiAll ( std::ostream &  os  )  [static]
Parameters:
os output stream

Enable ascii output on each device which is of the ns3::WifiNetDevice type and dump that to the specified stdc++ output stream.

Ptr<UanNetDevice> ns3::UanHelper::Install ( Ptr< Node >  node,
Ptr< UanChannel >  channel 
) const
Parameters:
node a node where to install the uan components

Create a default uan stack with:

  • default channel, ideal propagation and default noise model
  • default physical layer, with UanPhyGen
  • default transducer, half duplex acoustic modem with UanTransducerHd
  • default MAC layer, with UanMacAloha

Channel, physical layer, transducer and mac layer are added to the UanNetDevice and then added to the node.

NetDeviceContainer ns3::UanHelper::Install ( NodeContainer  c,
Ptr< UanChannel >  channel 
) const
Parameters:
channel a channel to use
c a set of nodes

For each of the input nodes, a new ns3::WifiNetDevice is attached to the shared input channel. Each ns3::WifiNetDevice is also configured with an ns3::WifiRemoteStationManager, ns3::WifiMac, and, ns3::WifiPhy, all of which are created based on the user-specified attributes specified in WifiHelper::SetRemoteStationManager, WifiHelper::SetMac, and, WifiHelper::SetPhy.

The user is expected to attach to the input channel a proper ns3::PropagationLossModel, and ns3::PropagationDelayModel.

NetDeviceContainer ns3::UanHelper::Install ( NodeContainer  c  )  const
Parameters:
c a set of nodes

This method creates a simple ns3::WifiChannel (with a default ns3::PropagationLossModel and ns3::PropagationDelayModel) and creates, for each of the input nodes, a new ns3::WifiNetDevice attached to this shared channel. Each ns3::WifiNetDevice is also configured with an ns3::WifiRemoteStationManager, ns3::WifiMac, and, ns3::WifiPhy, all of which are created based on the user-specified attributes specified in WifiHelper::SetRemoteStationManager, WifiHelper::SetMac, and, WifiHelper::SetPhy.

void ns3::UanHelper::SetMac ( 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::UanMac 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 mac.

void ns3::UanHelper::SetPhy ( std::string  phyType,
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:
phyType the type of ns3::UanPhy 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 phy.

void ns3::UanHelper::SetTransducer ( 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::Transducer 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 transducer.

The documentation for this class was generated from the following file:
Generated on 6 Jan 2011 for NS-3 by  doxygen 1.6.1