ns3::PointToPointStarHelper Class Reference

A helper to make it easier to create a star topology with PointToPoint links. More...

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

Collaboration diagram for ns3::PointToPointStarHelper:

List of all members.

Public Member Functions
	PointToPointStarHelper (uint32_t numSpokes, PointToPointHelper p2pHelper)
Ptr< Node >	GetHub () const
Ptr< Node >	GetSpokeNode (uint32_t i) const
Ipv4Address	GetHubIpv4Address (uint32_t i) const
Ipv4Address	GetSpokeIpv4Address (uint32_t i) const
uint32_t	SpokeCount () const
void	InstallStack (InternetStackHelper stack)
void	AssignIpv4Addresses (Ipv4AddressHelper address)
void	BoundingBox (double ulx, double uly, double lrx, double lry)

---

Detailed Description

A helper to make it easier to create a star topology with PointToPoint links.

---

Constructor & Destructor Documentation

ns3::PointToPointStarHelper::PointToPointStarHelper	(	uint32_t	numSpokes,
		PointToPointHelper	p2pHelper
	)

Create a PointToPointStarHelper in order to easily create star topologies using p2p links

Parameters:

	numSpokes	the number of links attached to the hub node, creating a total of numSpokes + 1 nodes
	p2pHelper	the link helper for p2p links, used to link nodes together

---

Member Function Documentation

void ns3::PointToPointStarHelper::AssignIpv4Addresses

(

Ipv4AddressHelper

address

)

Parameters:

address

an Ipv4AddressHelper which is used to install Ipv4 addresses on all the node interfaces in the star

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

Sets up the node canvas locations for every node in the star. 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::PointToPointStarHelper::GetHub

(

)

const

Returns:

a node pointer to the hub node in the star, i.e., the center node

Ipv4Address ns3::PointToPointStarHelper::GetHubIpv4Address

(

uint32_t

i

)

const

Parameters:

i

index into the hub interfaces

Returns:

Ipv4Address according to indexed hub interface

Ipv4Address ns3::PointToPointStarHelper::GetSpokeIpv4Address

(

uint32_t

i

)

const

Parameters:

i

index into the spoke interfaces

Returns:

Ipv4Address according to indexed spoke interface

Ptr<Node> ns3::PointToPointStarHelper::GetSpokeNode

(

uint32_t

i

)

const

Parameters:

i

an index into the spokes of the star

Returns:

a node pointer to the node at the indexed spoke

void ns3::PointToPointStarHelper::InstallStack

(

InternetStackHelper

stack

)

Parameters:

stack

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

uint32_t ns3::PointToPointStarHelper::SpokeCount

(

)

const

Returns:

the total number of spokes in the star

---

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

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