ns-3
ns3::CsmaStarHelper Class Reference

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

#include <csma-star-helper.h>

List of all members.

Public Member Functions

 CsmaStarHelper (uint32_t numSpokes, CsmaHelper csmaHelper)
Ptr< NodeGetHub () const
Ptr< NodeGetSpokeNode (uint32_t i) const
NetDeviceContainer GetHubDevices () const
NetDeviceContainer GetSpokeDevices () 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)

Detailed Description

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


Constructor & Destructor Documentation

ns3::CsmaStarHelper::CsmaStarHelper ( uint32_t  numSpokes,
CsmaHelper  csmaHelper 
)

Create a CsmaStarHelper in order to easily create star topologies using Csma links

Parameters:
numSpokesthe number of links attached to the hub node, creating a total of numSpokes + 1 nodes
csmaHelperthe link helper for Csma links, used to link nodes together

References ns3::NetDeviceContainer::Add(), ns3::NodeContainer::Create(), ns3::NodeContainer::Get(), ns3::NodeContainer::GetN(), and ns3::CsmaHelper::Install().


Member Function Documentation

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

References ns3::NodeContainer::Get().

Returns:
the net-device container which contains all of the devices on the hub node
Parameters:
iindex into the hub interfaces
Returns:
Ipv4Address according to indexed hub interface

References ns3::Ipv4InterfaceContainer::GetAddress().

Returns:
the net-device container which contains all of the spoke node devices
Parameters:
iindex into the spoke interfaces
Returns:
Ipv4Address according to indexed spoke interface

References ns3::Ipv4InterfaceContainer::GetAddress().

Ptr< Node > ns3::CsmaStarHelper::GetSpokeNode ( uint32_t  i) const
Parameters:
ian index into the spokes of the star
Returns:
a node pointer to the node at the indexed spoke

References ns3::NodeContainer::Get().

Parameters:
stackan InternetStackHelper which is used to install on every node in the star

References ns3::InternetStackHelper::Install().

uint32_t ns3::CsmaStarHelper::SpokeCount ( ) const
Returns:
the total number of spokes in the star

References ns3::NodeContainer::GetN().


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