Public Member Functions

ns3::EmuHelper Class Reference

build a set of EmuNetDevice objects More...

#include <emu-helper.h>

Inheritance diagram for ns3::EmuHelper:
Inheritance graph
[legend]
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

Detailed Description

build a set of EmuNetDevice objects

Normally we eschew multiple inheritance, however, the classes PcapUserHelperForDevice and AsciiTraceUserHelperForDevice are treated as "mixins". A mixin is a self-contained class that encapsulates a general attribute or a set of functionality that may be of interest to many other classes.


Member Function Documentation

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 container holding the added net device.
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 container 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 container 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: