ns3::CsmaStarHelper Class Reference

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

#include <csma-star-helper.h>

Collaboration diagram for ns3::CsmaStarHelper:

Public Member Functions
	CsmaStarHelper (uint32_t numSpokes, CsmaHelper csmaHelper)
	Create a CsmaStarHelper in order to easily create star topologies using Csma links. More...
	~CsmaStarHelper ()
void	AssignIpv4Addresses (Ipv4AddressHelper address)
void	AssignIpv6Addresses (Ipv6Address network, Ipv6Prefix prefix)
Ptr< Node >	GetHub () const
NetDeviceContainer	GetHubDevices () const
Ipv4Address	GetHubIpv4Address (uint32_t i) const
Ipv6Address	GetHubIpv6Address (uint32_t i) const
NetDeviceContainer	GetSpokeDevices () const
Ipv4Address	GetSpokeIpv4Address (uint32_t i) const
Ipv6Address	GetSpokeIpv6Address (uint32_t i) const
Ptr< Node >	GetSpokeNode (uint32_t i) const
void	InstallStack (InternetStackHelper stack)
uint32_t	SpokeCount () const

Private Attributes
NodeContainer	m_hub
NetDeviceContainer	m_hubDevices
Ipv4InterfaceContainer	m_hubInterfaces
Ipv6InterfaceContainer	m_hubInterfaces6
NetDeviceContainer	m_spokeDevices
Ipv4InterfaceContainer	m_spokeInterfaces
Ipv6InterfaceContainer	m_spokeInterfaces6
NodeContainer	m_spokes

Detailed Description

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

Definition at line 45 of file csma-star-helper.h.

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

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

Definition at line 31 of file csma-star-helper.cc.

References ns3::NetDeviceContainer::Add(), ns3::NodeContainer::Create(), ns3::NodeContainer::Get(), ns3::NodeContainer::GetN(), ns3::CsmaHelper::Install(), m_hub, m_hubDevices, m_spokeDevices, m_spokes, and first::nodes.

Here is the call graph for this function:

ns3::CsmaStarHelper::~CsmaStarHelper

(

)

Definition at line 46 of file csma-star-helper.cc.

Member Function Documentation

void ns3::CsmaStarHelper::AssignIpv4Addresses

(

Ipv4AddressHelper

address

)

Parameters

address

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

Definition at line 112 of file csma-star-helper.cc.

References ns3::Ipv4InterfaceContainer::Add(), ns3::Ipv4AddressHelper::Assign(), ns3::NetDeviceContainer::Get(), ns3::NodeContainer::GetN(), m_hubDevices, m_hubInterfaces, m_spokeDevices, m_spokeInterfaces, m_spokes, and ns3::Ipv4AddressHelper::NewNetwork().

Referenced by CsmaStarTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::CsmaStarHelper::AssignIpv6Addresses	(	Ipv6Address	network,
		Ipv6Prefix	prefix
	)

Parameters

network	an IPv6 Address representing the network portion of the Ipv6 Address
prefix	the prefix length

Definition at line 123 of file csma-star-helper.cc.

References ns3::Ipv6InterfaceContainer::Add(), ns3::Ipv6AddressHelper::Assign(), ns3::NetDeviceContainer::Get(), ns3::NodeContainer::GetN(), ns3::Ipv6AddressGenerator::GetNetwork(), ns3::Ipv6AddressGenerator::Init(), m_hubDevices, m_hubInterfaces6, m_spokeDevices, m_spokeInterfaces6, m_spokes, ns3::Ipv6AddressGenerator::NextNetwork(), and ns3::Ipv6AddressHelper::SetBase().

Here is the call graph for this function:

Ptr< Node > ns3::CsmaStarHelper::GetHub

(

)

const

Returns

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

Definition at line 51 of file csma-star-helper.cc.

References ns3::NodeContainer::Get(), and m_hub.

Referenced by CsmaStarTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

NetDeviceContainer ns3::CsmaStarHelper::GetHubDevices

(

)

const

Returns

the net-device container which contains all of the devices on the hub node

Definition at line 63 of file csma-star-helper.cc.

References m_hubDevices.

Ipv4Address ns3::CsmaStarHelper::GetHubIpv4Address

(

uint32_t

i

)

const

Parameters

i	index into the hub interfaces

Returns

Ipv4Address according to indexed hub interface

Definition at line 75 of file csma-star-helper.cc.

References ns3::Ipv4InterfaceContainer::GetAddress(), and m_hubInterfaces.

Referenced by CsmaStarTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

Ipv6Address ns3::CsmaStarHelper::GetHubIpv6Address

(

uint32_t

i

)

const

Parameters

i	index into the hub interfaces

Returns

Ipv6Address according to indexed hub interface

Definition at line 87 of file csma-star-helper.cc.

References ns3::Ipv6InterfaceContainer::GetAddress(), and m_hubInterfaces6.

Here is the call graph for this function:

NetDeviceContainer ns3::CsmaStarHelper::GetSpokeDevices

(

)

const

Returns

the net-device container which contains all of the spoke node devices

Definition at line 69 of file csma-star-helper.cc.

References m_spokeDevices.

Referenced by CsmaStarTestCase::DoRun().

Here is the caller graph for this function:

Ipv4Address ns3::CsmaStarHelper::GetSpokeIpv4Address

(

uint32_t

i

)

const

Parameters

i	index into the spoke interfaces

Returns

Ipv4Address according to indexed spoke interface

Definition at line 81 of file csma-star-helper.cc.

References ns3::Ipv4InterfaceContainer::GetAddress(), and m_spokeInterfaces.

Here is the call graph for this function:

Ipv6Address ns3::CsmaStarHelper::GetSpokeIpv6Address

(

uint32_t

i

)

const

Parameters

i	index into the spoke interfaces

Returns

Ipv6Address according to indexed spoke interface

Definition at line 93 of file csma-star-helper.cc.

References ns3::Ipv6InterfaceContainer::GetAddress(), and m_spokeInterfaces6.

Here is the call graph for this function:

Ptr< Node > ns3::CsmaStarHelper::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

Definition at line 57 of file csma-star-helper.cc.

References ns3::NodeContainer::Get(), and m_spokes.

Referenced by CsmaStarTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::CsmaStarHelper::InstallStack

(

InternetStackHelper

stack

)

Parameters

stack

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

Definition at line 105 of file csma-star-helper.cc.

References ns3::InternetStackHelper::Install(), m_hub, and m_spokes.

Referenced by CsmaStarTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::CsmaStarHelper::SpokeCount

(

)

const

Returns

the total number of spokes in the star

Definition at line 99 of file csma-star-helper.cc.

References ns3::NodeContainer::GetN(), and m_spokes.

Referenced by CsmaStarTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

NodeContainer ns3::CsmaStarHelper::m_hub

private

Definition at line 144 of file csma-star-helper.h.

Referenced by CsmaStarHelper(), GetHub(), and InstallStack().

NetDeviceContainer ns3::CsmaStarHelper::m_hubDevices

private

Definition at line 145 of file csma-star-helper.h.

Referenced by AssignIpv4Addresses(), AssignIpv6Addresses(), CsmaStarHelper(), and GetHubDevices().

Ipv4InterfaceContainer ns3::CsmaStarHelper::m_hubInterfaces

private

Definition at line 148 of file csma-star-helper.h.

Referenced by AssignIpv4Addresses(), and GetHubIpv4Address().

Ipv6InterfaceContainer ns3::CsmaStarHelper::m_hubInterfaces6

private

Definition at line 150 of file csma-star-helper.h.

Referenced by AssignIpv6Addresses(), and GetHubIpv6Address().

NetDeviceContainer ns3::CsmaStarHelper::m_spokeDevices

private

Definition at line 147 of file csma-star-helper.h.

Referenced by AssignIpv4Addresses(), AssignIpv6Addresses(), CsmaStarHelper(), and GetSpokeDevices().

Ipv4InterfaceContainer ns3::CsmaStarHelper::m_spokeInterfaces

private

Definition at line 149 of file csma-star-helper.h.

Referenced by AssignIpv4Addresses(), and GetSpokeIpv4Address().

Ipv6InterfaceContainer ns3::CsmaStarHelper::m_spokeInterfaces6

private

Definition at line 151 of file csma-star-helper.h.

Referenced by AssignIpv6Addresses(), and GetSpokeIpv6Address().

NodeContainer ns3::CsmaStarHelper::m_spokes

private

Definition at line 146 of file csma-star-helper.h.

Referenced by AssignIpv4Addresses(), AssignIpv6Addresses(), CsmaStarHelper(), GetSpokeNode(), InstallStack(), and SpokeCount().

---

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

• src/csma-layout/model/csma-star-helper.h
• src/csma-layout/model/csma-star-helper.cc