ns3::PointToPointDumbbellHelper Class Reference

A helper to make it easier to create a dumbbell topology with p2p links. More...

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

Collaboration diagram for ns3::PointToPointDumbbellHelper:

[legend]

List of all members.

Public Member Functions
	PointToPointDumbbellHelper (uint32_t nLeftLeaf, PointToPointHelper leftHelper, uint32_t nRightLeaf, PointToPointHelper rightHelper, PointToPointHelper bottleneckHelper)
Ptr< Node >	GetLeft () const
Ptr< Node >	GetLeft (uint32_t i) const
Ptr< Node >	GetRight () const
Ptr< Node >	GetRight (uint32_t i) const
Ipv4Address	GetLeftIpv4Address (uint32_t i) const
Ipv4Address	GetRightIpv4Address (uint32_t i) const
uint32_t	LeftCount () const
uint32_t	RightCount () const
void	InstallStack (InternetStackHelper stack)
void	AssignIpv4Addresses (Ipv4AddressHelper leftIp, Ipv4AddressHelper rightIp, Ipv4AddressHelper routerIp)
void	BoundingBox (double ulx, double uly, double lrx, double lry)

---

Detailed Description

A helper to make it easier to create a dumbbell topology with p2p links.

---

Constructor & Destructor Documentation

ns3::PointToPointDumbbellHelper::PointToPointDumbbellHelper	(	uint32_t	nLeftLeaf,
		PointToPointHelper	leftHelper,
		uint32_t	nRightLeaf,
		PointToPointHelper	rightHelper,
		PointToPointHelper	bottleneckHelper
	)

Create a PointToPointDumbbellHelper in order to easily create dumbbell topologies using p2p links

Parameters:

	nLeftLeaf	number of left side leaf nodes in the dumbbell
	leftHelper	PointToPointHelper used to install the links between the left leaf nodes and the left-most router
	nRightLeaf	number of right side leaf nodes in the dumbbell
	rightHelper	PointToPointHelper used to install the links between the right leaf nodes and the right-most router
	bottleneckHelper	PointToPointHelper used to install the link between the inner-routers, usually known as the bottleneck link

---

Member Function Documentation

void ns3::PointToPointDumbbellHelper::AssignIpv4Addresses	(	Ipv4AddressHelper	leftIp,
		Ipv4AddressHelper	rightIp,
		Ipv4AddressHelper	routerIp
	)

Parameters:

	leftIp	Ipv4AddressHelper to assign Ipv4 addresses to the interfaces on the left side of the dumbbell
	rightIp	Ipv4AddressHelper to assign Ipv4 addresses to the interfaces on the right side of the dumbbell
	routerIp	Ipv4AddressHelper to assign Ipv4 addresses to the interfaces on the bottleneck link

void ns3::PointToPointDumbbellHelper::BoundingBox	(	double	ulx,
		double	uly,
		double	lrx,
		double	lry
	)

Sets up the node canvas locations for every node in the dumbbell. This is needed for use with the animation interface

Parameters:

	ulx	upper left x value
	uly	upper left y value
	lrx	lower right x value
	lry	lower right y value

Ptr<Node> ns3::PointToPointDumbbellHelper::GetLeft

(

uint32_t

i

)

const

Returns:

pointer to the i'th left side leaf node

Ptr<Node> ns3::PointToPointDumbbellHelper::GetLeft

(

)

const

Returns:

pointer to the node of the left side bottleneck router

Ipv4Address ns3::PointToPointDumbbellHelper::GetLeftIpv4Address

(

uint32_t

i

)

const

Returns:

an Ipv4Address of the i'th left leaf

Ptr<Node> ns3::PointToPointDumbbellHelper::GetRight

(

uint32_t

i

)

const

Returns:

pointer to the i'th left side leaf node

Ptr<Node> ns3::PointToPointDumbbellHelper::GetRight

(

)

const

Returns:

pointer to the node of the right side bottleneck router

Ipv4Address ns3::PointToPointDumbbellHelper::GetRightIpv4Address

(

uint32_t

i

)

const

Returns:

an Ipv4Address of the i'th right leaf

void ns3::PointToPointDumbbellHelper::InstallStack

(

InternetStackHelper

stack

)

Parameters:

stack

an InternetStackHelper which is used to install on every node in the dumbbell

uint32_t ns3::PointToPointDumbbellHelper::LeftCount

(

)

const

Returns:

total number of left side leaf nodes

uint32_t ns3::PointToPointDumbbellHelper::RightCount

(

)

const

Returns:

total number of right side leaf nodes

---

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

• src/helper/point-to-point-dumbbell-helper.h