NS-3
ns3::PointToPointHelper Class Reference

Build a set of PointToPointNetDevice objects. More...

#include <point-to-point-helper.h>

Inheritance diagram for ns3::PointToPointHelper:
Collaboration diagram for ns3::PointToPointHelper:

List of all members.

Public Member Functions

 PointToPointHelper ()
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 SetDeviceAttribute (std::string name, const AttributeValue &value)
void SetChannelAttribute (std::string name, const AttributeValue &value)
NetDeviceContainer Install (NodeContainer c)
NetDeviceContainer Install (Ptr< Node > a, Ptr< Node > b)
NetDeviceContainer Install (Ptr< Node > a, std::string bName)
NetDeviceContainer Install (std::string aName, Ptr< Node > b)
NetDeviceContainer Install (std::string aNode, std::string bNode)

Detailed Description

Build a set of PointToPointNetDevice objects.

Normally we eschew multiple inheritance, however, the classes PcapUserHelperForDevice and AsciiTraceUserHelperForDevice are "mixins".


Constructor & Destructor Documentation

ns3::PointToPointHelper::PointToPointHelper ( )

Create a PointToPointHelper to make life easier when creating point to point networks.


Member Function Documentation

NetDeviceContainer ns3::PointToPointHelper::Install ( NodeContainer  c)
Parameters:
ca set of nodes

This method creates a ns3::PointToPointChannel with the attributes configured by PointToPointHelper::SetChannelAttribute, then, for each node in the input container, we create a ns3::PointToPointNetDevice with the requested attributes, a queue for this ns3::NetDevice, and associate the resulting ns3::NetDevice with the ns3::Node and ns3::PointToPointChannel.

NetDeviceContainer ns3::PointToPointHelper::Install ( Ptr< Node a,
Ptr< Node b 
)
Parameters:
afirst node
bsecond node

Saves you from having to construct a temporary NodeContainer. Also, if MPI is enabled, for distributed simulations, appropriate remote point-to-point channels are created.

NetDeviceContainer ns3::PointToPointHelper::Install ( std::string  aName,
Ptr< Node b 
)
Parameters:
aNameName of first node
bsecond node

Saves you from having to construct a temporary NodeContainer.

NetDeviceContainer ns3::PointToPointHelper::Install ( std::string  aNode,
std::string  bNode 
)
Parameters:
aNodeName of first node
bNodeName of second node

Saves you from having to construct a temporary NodeContainer.

NetDeviceContainer ns3::PointToPointHelper::Install ( Ptr< Node a,
std::string  bName 
)
Parameters:
afirst node
bNamename of second node

Saves you from having to construct a temporary NodeContainer.

void ns3::PointToPointHelper::SetChannelAttribute ( std::string  name,
const AttributeValue value 
)

Set an attribute value to be propagated to each Channel created by the helper.

Parameters:
namethe name of the attribute to set
valuethe value of the attribute to set

Set these attribute on each ns3::PointToPointChannel created by PointToPointHelper::Install

void ns3::PointToPointHelper::SetDeviceAttribute ( std::string  name,
const AttributeValue value 
)

Set an attribute value to be propagated to each NetDevice created by the helper.

Parameters:
namethe name of the attribute to set
valuethe value of the attribute to set

Set these attributes on each ns3::PointToPointNetDevice created by PointToPointHelper::Install

void ns3::PointToPointHelper::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() 
)

Each point to point net device must have a queue to pass packets through. This method allows one to set the type of the queue that is automatically created when the device is created and attached to a node.

Parameters:
typethe type of queue
n1the name of the attribute to set on the queue
v1the value of the attribute to set on the queue
n2the name of the attribute to set on the queue
v2the value of the attribute to set on the queue
n3the name of the attribute to set on the queue
v3the value of the attribute to set on the queue
n4the name of the attribute to set on the queue
v4the value of the attribute to set on the queue

Set the type of queue to create and associated to each PointToPointNetDevice created through PointToPointHelper::Install.


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