ns3::EmuHelper Class Reference

build a set of EmuNetDevice objects More...

#include <emu-helper.h>

Collaboration diagram for ns3::EmuHelper:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void SetQueue (std::string type, 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())
void SetAttribute (std::string n1, const AttributeValue &v1)
NetDeviceContainer Install (Ptr< Node > node) const
NetDeviceContainer Install (std::string nodeName) const
NetDeviceContainer Install (const NodeContainer &c) const

Static Public Member Functions

static void EnablePcap (std::string filename, uint32_t nodeid, uint32_t deviceid, bool promiscuous)
static void EnablePcap (std::string filename, Ptr< NetDevice > nd, bool promiscuous)
static void EnablePcap (std::string filename, std::string ndName, bool promiscuous)
static void EnablePcap (std::string filename, NetDeviceContainer d, bool promiscuous)
static void EnablePcap (std::string filename, NodeContainer n, bool promiscuous)
static void EnablePcapAll (std::string filename, bool promiscuous)
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)


Detailed Description

build a set of EmuNetDevice objects

Member Function Documentation

static void ns3::EmuHelper::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::EmuNetDevice type and which is located in one of the input node and dump that to the specified stdc++ output stream.

static void ns3::EmuHelper::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::EmuNetDevice type and which is located in the input device container and dump that to the specified stdc++ output stream.

static void ns3::EmuHelper::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::EmuNetDevice and dump that to the specified stdc++ output stream.

static void ns3::EmuHelper::EnableAsciiAll ( std::ostream &  os  )  [static]

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

static void ns3::EmuHelper::EnablePcap ( std::string  filename,
NodeContainer  n,
bool  promiscuous 
) [static]

Parameters:
filename filename prefix to use for pcap files.
n container of nodes.
promiscuous If true capture all possible packets available at the device.
Enable pcap output on each device which is of the ns3::EmuNetDevice type and which is located in one of the input nodes.

static void ns3::EmuHelper::EnablePcap ( std::string  filename,
NetDeviceContainer  d,
bool  promiscuous 
) [static]

Parameters:
filename filename prefix to use for pcap files.
d container of devices of type ns3::EmuNetDevice
promiscuous If true capture all possible packets available at the device.
Enable pcap output on each input device which is of the ns3::EmuNetDevice type.

static void ns3::EmuHelper::EnablePcap ( std::string  filename,
std::string  ndName,
bool  promiscuous 
) [static]

Parameters:
filename filename prefix to use for pcap files.
ndName Name of net device on which you want to enable tracing.
promiscuous If true capture all possible packets available at the device.
Enable pcap output on each input device which is of the ns3::EmuNetDevice type.

static void ns3::EmuHelper::EnablePcap ( std::string  filename,
Ptr< NetDevice nd,
bool  promiscuous 
) [static]

Parameters:
filename filename prefix to use for pcap files.
nd Indicates net device on which you want to enable tracing.
promiscuous If true capture all possible packets available at the device.
Enable pcap output on each input device which is of the ns3::EmuNetDevice type.

static void ns3::EmuHelper::EnablePcap ( std::string  filename,
uint32_t  nodeid,
uint32_t  deviceid,
bool  promiscuous 
) [static]

Parameters:
filename filename prefix to use for pcap files.
nodeid the id of the node to generate pcap output for.
deviceid the id of the device to generate pcap output for.
promiscuous If true capture all possible packets available at the device.
Generate a pcap file which contains the link-level data observed by the specified deviceid within the specified nodeid. The pcap data is stored in the file prefix-nodeid-deviceid.pcap.

This method should be invoked after the network topology has been fully constructed.

static void ns3::EmuHelper::EnablePcapAll ( std::string  filename,
bool  promiscuous 
) [static]

Parameters:
filename filename prefix to use for pcap files.
promiscuous If true capture all possible packets available at the device.
Enable pcap output on each device which is of the ns3::EmuNetDevice type

NetDeviceContainer ns3::EmuHelper::Install ( const NodeContainer c  )  const

For each Ptr<node> in the provided container this method creates an ns3::EmuNetDevice (with the attributes configured by EmuHelper::SetDeviceAttribute); adds the device to the node.

Parameters:
c The NodeContainer holding the nodes to be changed.
Returns:
A containter holding the added net devices.

NetDeviceContainer ns3::EmuHelper::Install ( std::string  nodeName  )  const

This method creates an ns3::EmuNetDevice with the attributes configured by EmuHelper::SetDeviceAttribute and then adds the device to the node.

Parameters:
nodeName The name of the node to install the device in
Returns:
A containter holding the added net device.

NetDeviceContainer ns3::EmuHelper::Install ( Ptr< Node node  )  const

This method creates an ns3::EmuNetDevice with the attributes configured by EmuHelper::SetDeviceAttribute and then adds the device to the node.

Parameters:
node The node to install the device in
Returns:
A containter holding the added net device.

void ns3::EmuHelper::SetAttribute ( std::string  n1,
const AttributeValue v1 
)

Parameters:
n1 the name of the attribute to set
v1 the value of the attribute to set
Set these attributes on each ns3::EmuNetDevice created by EmuHelper::Install

void ns3::EmuHelper::SetQueue ( std::string  type,
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() 
)

Parameters:
type the type of queue
n1 the name of the attribute to set on the queue
v1 the value of the attribute to set on the queue
n2 the name of the attribute to set on the queue
v2 the value of the attribute to set on the queue
n3 the name of the attribute to set on the queue
v3 the value of the attribute to set on the queue
n4 the name of the attribute to set on the queue
v4 the value of the attribute to set on the queue
Set the type of queue to create and associated to each EmuNetDevice created through EmuHelper::Install.


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