keep track of a set of node pointers. More...

#include "node-container.h"

Collaboration diagram for ns3::NodeContainer:

Public Types
typedef std::vector< Ptr< Node > >::const_iterator	Iterator
	Node container iterator. More...

Public Member Functions
	NodeContainer ()
	Create an empty NodeContainer. More...

	NodeContainer (const NodeContainer &a, const NodeContainer &b)
	Create a node container which is a concatenation of two input NodeContainers. More...

	NodeContainer (const NodeContainer &a, const NodeContainer &b, const NodeContainer &c)
	Create a node container which is a concatenation of three input NodeContainers. More...

	NodeContainer (const NodeContainer &a, const NodeContainer &b, const NodeContainer &c, const NodeContainer &d)
	Create a node container which is a concatenation of four input NodeContainers. More...

	NodeContainer (const NodeContainer &a, const NodeContainer &b, const NodeContainer &c, const NodeContainer &d, const NodeContainer &e)
	Create a node container which is a concatenation of five input NodeContainers. More...

	NodeContainer (Ptr< Node > node)
	Create a NodeContainer with exactly one node which has been previously instantiated. More...

	NodeContainer (std::string nodeName)
	Create a NodeContainer with exactly one node which has been previously instantiated and assigned a name using the Object Name Service. More...

	NodeContainer (uint32_t n, uint32_t systemId=0)
	Create a NodeContainer with the requested number of Nodes. More...

void	Add (NodeContainer other)
	Append the contents of another NodeContainer to the end of this container. More...

void	Add (Ptr< Node > node)
	Append a single Ptr<Node> to this container. More...

void	Add (std::string nodeName)
	Append to this container the single Ptr<Node> referred to via its object name service registered name. More...

Iterator	Begin (void) const
	Get an iterator which refers to the first Node in the container. More...

bool	Contains (uint32_t id) const
	Return true if container contains a Node with index id. More...

void	Create (uint32_t n)
	Create n nodes and append pointers to them to the end of this NodeContainer. More...

void	Create (uint32_t n, uint32_t systemId)
	Create n nodes with specified systemId for distributed simulations and append pointers to them to the end of this NodeContainer. More...

Iterator	End (void) const
	Get an iterator which indicates past-the-last Node in the container. More...

Ptr< Node >	Get (uint32_t i) const
	Get the Ptr<Node> stored in this container at a given index. More...

uint32_t	GetN (void) const
	Get the number of Ptr<Node> stored in this container. More...

Static Public Member Functions
static NodeContainer	GetGlobal (void)
	Create a NodeContainer that contains a list of all nodes created through NodeContainer::Create() and stored in the ns3::NodeList. More...

Private Attributes
std::vector< Ptr< Node > >	m_nodes
	Nodes smart pointers. More...

Detailed Description

keep track of a set of node pointers.

Typically ns-3 helpers operate on more than one node at a time. For example a device helper may want to install devices on a large number of similar nodes. The helper Install methods usually take a NodeContainer as a parameter. NodeContainers hold the multiple Ptr<Node> which are used to refer to the nodes.

Definition at line 38 of file node-container.h.

Member Typedef Documentation

◆ Iterator

typedef std::vector<Ptr<Node> >::const_iterator ns3::NodeContainer::Iterator

Node container iterator.

Definition at line 42 of file node-container.h.

Constructor & Destructor Documentation

◆ NodeContainer() [1/8]

ns3::NodeContainer::NodeContainer ( )

Create an empty NodeContainer.

Definition at line 26 of file node-container.cc.

◆ NodeContainer() [2/8]

ns3::NodeContainer::NodeContainer ( Ptr< Node > node )

Create a NodeContainer with exactly one node which has been previously instantiated.

The single Node is specified by a smart pointer.

Parameters

node	The Ptr<Node> to add to the container.

Definition at line 30 of file node-container.cc.

References m_nodes.

◆ NodeContainer() [3/8]

ns3::NodeContainer::NodeContainer ( std::string nodeName )

Create a NodeContainer with exactly one node which has been previously instantiated and assigned a name using the Object Name Service.

This Node is then specified by its assigned name.

Parameters

nodeName The name of the Node Object to add to the container.

Definition at line 34 of file node-container.cc.

References m_nodes.

◆ NodeContainer() [4/8]

ns3::NodeContainer::NodeContainer	(	uint32_t	n,
		uint32_t	systemId = `0`
	)

Create a NodeContainer with the requested number of Nodes.

This is syntatic sugar for

NodeContainer nodes;
nodes.Create (size);
// or nodes.Create (size, systemId);

Parameters

[in]	n	The number of nodes to create.
[in]	systemId	The system id or rank associated with this node

Definition at line 39 of file node-container.cc.

References Create(), and m_nodes.

Here is the call graph for this function:

◆ NodeContainer() [5/8]

ns3::NodeContainer::NodeContainer	(	const NodeContainer &	a,
		const NodeContainer &	b
	)

Create a node container which is a concatenation of two input NodeContainers.

Parameters

a	The first NodeContainer
b	The second NodeContainer

Note: A frequently seen idiom that uses these constructors involves the implicit conversion by constructor of Ptr<Node>. When used, two Ptr<Node> will be passed to this constructor instead of NodeContainer&. C++ will notice the implicit conversion path that goes through the NodeContainer (Ptr<Node> node) constructor above. Using this conversion one may provide optionally provide arguments of Ptr<Node> to these constructors.

Definition at line 44 of file node-container.cc.

References Add().

Here is the call graph for this function:

◆ NodeContainer() [6/8]

ns3::NodeContainer::NodeContainer	(	const NodeContainer &	a,
		const NodeContainer &	b,
		const NodeContainer &	c
	)

Create a node container which is a concatenation of three input NodeContainers.

Parameters

a	The first NodeContainer
b	The second NodeContainer
c	The third NodeContainer

Note: A frequently seen idiom that uses these constructors involves the implicit conversion by constructor of Ptr<Node>. When used, two Ptr<Node> will be passed to this constructor instead of NodeContainer&. C++ will notice the implicit conversion path that goes through the NodeContainer (Ptr<Node> node) constructor above. Using this conversion one may provide optionally provide arguments of Ptr<Node> to these constructors.

Definition at line 49 of file node-container.cc.

References Add().

Here is the call graph for this function:

◆ NodeContainer() [7/8]

ns3::NodeContainer::NodeContainer	(	const NodeContainer &	a,
		const NodeContainer &	b,
		const NodeContainer &	c,
		const NodeContainer &	d
	)

Create a node container which is a concatenation of four input NodeContainers.

Parameters

a	The first NodeContainer
b	The second NodeContainer
c	The third NodeContainer
d	The fourth NodeContainer

Note: A frequently seen idiom that uses these constructors involves the implicit conversion by constructor of Ptr<Node>. When used, two Ptr<Node> will be passed to this constructor instead of NodeContainer&. C++ will notice the implicit conversion path that goes through the NodeContainer (Ptr<Node> node) constructor above. Using this conversion one may provide optionally provide arguments of Ptr<Node> to these constructors.

Definition at line 56 of file node-container.cc.

References Add().

Here is the call graph for this function:

◆ NodeContainer() [8/8]

ns3::NodeContainer::NodeContainer	(	const NodeContainer &	a,
		const NodeContainer &	b,
		const NodeContainer &	c,
		const NodeContainer &	d,
		const NodeContainer &	e
	)

Create a node container which is a concatenation of five input NodeContainers.

Parameters

a	The first NodeContainer
b	The second NodeContainer
c	The third NodeContainer
d	The fourth NodeContainer
e	The fifth NodeContainer

Note: A frequently seen idiom that uses these constructors involves the implicit conversion by constructor of Ptr<Node>. When used, two Ptr<Node> will be passed to this constructor instead of NodeContainer&. C++ will notice the implicit conversion path that goes through the NodeContainer (Ptr<Node> node) constructor above. Using this conversion one may provide optionally provide arguments of Ptr<Node> to these constructors.

Definition at line 65 of file node-container.cc.

References Add().

Here is the call graph for this function:

Member Function Documentation

◆ Add() [1/3]

void ns3::NodeContainer::Add ( NodeContainer other )

Append the contents of another NodeContainer to the end of this container.

Parameters

other The NodeContainer to append.

Definition at line 114 of file node-container.cc.

References Begin(), End(), and m_nodes.

Referenced by NodeContainer(), Experiment::AssignNeighbors(), ns3::BriteTopologyHelper::BuildBriteTopology(), BriteTopologyFunctionTestCase::DoRun(), IcmpTimeExceedTestCase::DoRun(), IcmpV6TimeExceedTestCase::DoRun(), EpcS1uDlTestCase::DoRun(), EpcS1uUlTestCase::DoRun(), NixVectorRoutingTest::DoRun(), CsmaPingTestCase::DoRun(), CsmaStarTestCase::DoRun(), Ns3TcpLossTestCase::DoRun(), Ns3TcpStateTestCase::DoRun(), Experiment::GenerateNeighbors(), and GetGlobal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Add() [2/3]

void ns3::NodeContainer::Add ( Ptr< Node > node )

Append a single Ptr<Node> to this container.

Parameters

node	The Ptr<Node> to append.

Definition at line 122 of file node-container.cc.

References m_nodes.

◆ Add() [3/3]

void ns3::NodeContainer::Add ( std::string nodeName )

Append to this container the single Ptr<Node> referred to via its object name service registered name.

Parameters

nodeName The name of the Node Object to add to the container.

Definition at line 127 of file node-container.cc.

References m_nodes.

◆ Begin()

NodeContainer::Iterator ns3::NodeContainer::Begin ( void ) const

Get an iterator which refers to the first Node in the container.

Nodes can be retrieved from the container in two ways. First, directly by an index into the container, and second, using an iterator. This method is used in the iterator method and is typically used in a for-loop to run through the Nodes

NodeContainer::Iterator i;
for (i = container.Begin (); i != container.End (); ++i)
  {
    (*i)->method ();  // some Node method
  }

Returns: an iterator which refers to the first Node in the container.

Definition at line 77 of file node-container.cc.

References m_nodes.

Here is the caller graph for this function:

◆ Contains()

bool ns3::NodeContainer::Contains ( uint32_t id ) const

Return true if container contains a Node with index id.

Returns: whether the NodeContainer contains a node with index id

Parameters

id Node Id

Definition at line 145 of file node-container.cc.

References m_nodes.

◆ Create() [1/2]

void ns3::NodeContainer::Create ( uint32_t n )

Create n nodes and append pointers to them to the end of this NodeContainer.

Nodes are at the heart of any ns-3 simulation. One of the first tasks that any simulation needs to do is to create a number of nodes. This method automates that task.

Parameters

n	The number of Nodes to create

Definition at line 98 of file node-container.cc.

References m_nodes.

◆ Create() [2/2]

void ns3::NodeContainer::Create	(	uint32_t	n,
		uint32_t	systemId
	)

Create n nodes with specified systemId for distributed simulations and append pointers to them to the end of this NodeContainer.

Nodes are at the heart of any ns-3 simulation. One of the first tasks that any simulation needs to do is to create a number of nodes. This method automates that task, and adds the ability to specify systemId for distributed simulations.

Parameters

n	The number of Nodes to create
systemId	The system id or rank associated with this node

Definition at line 106 of file node-container.cc.

References m_nodes.

◆ End()

NodeContainer::Iterator ns3::NodeContainer::End ( void ) const

Get an iterator which indicates past-the-last Node in the container.

Nodes can be retrieved from the container in two ways. First, directly by an index into the container, and second, using an iterator. This method is used in the iterator method and is typically used in a for-loop to run through the Nodes

NodeContainer::Iterator i;
for (i = container.Begin (); i != container.End (); ++i)
  {
    (*i)->method ();  // some Node method
  }

Returns: an iterator which indicates an ending condition for a loop.

Definition at line 82 of file node-container.cc.

References m_nodes.

Here is the caller graph for this function:

◆ Get()

Ptr< Node > ns3::NodeContainer::Get ( uint32_t i ) const

Get the Ptr<Node> stored in this container at a given index.

Nodes can be retrieved from the container in two ways. First, directly by an index into the container, and second, using an iterator. This method is used in the direct method and is used to retrieve the indexed Ptr<Appliation>.

uint32_t nNodes = container.GetN ();
for (uint32_t i = 0 i < nNodes; ++i)
  {
    Ptr<Node> p = container.Get (i)
    i->method ();  // some Node method
  }

Parameters

i	the index of the requested node pointer.

Returns: the requested node pointer.

Definition at line 93 of file node-container.cc.

References m_nodes.

◆ GetGlobal()

NodeContainer ns3::NodeContainer::GetGlobal ( void )

static

Create a NodeContainer that contains a list of all nodes created through NodeContainer::Create() and stored in the ns3::NodeList.

Whenever a Node is created, a Ptr<Node> is added to a global list of all nodes in the system. It is sometimes useful to be able to get to all nodes in one place. This method creates a NodeContainer that is initialized to contain all of the simulation nodes,

Returns: a NoceContainer which contains a list of all Nodes.

Definition at line 134 of file node-container.cc.

References Add(), ns3::NodeList::Begin(), and ns3::NodeList::End().

Referenced by ns3::DistributedSimulatorImpl::CalculateLookAhead(), ns3::NullMessageSimulatorImpl::CalculateLookAhead(), ns3::MobilityHelper::EnableAsciiAll(), ns3::UanHelper::EnableAsciiAll(), ns3::AsciiTraceHelperForDevice::EnableAsciiAll(), ns3::AsciiTraceHelperForDevice::EnableAsciiImpl(), ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4All(), ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4Impl(), ns3::AsciiTraceHelperForIpv6::EnableAsciiIpv6All(), ns3::AsciiTraceHelperForIpv6::EnableAsciiIpv6Impl(), ns3::PcapHelperForDevice::EnablePcap(), ns3::PcapHelperForDevice::EnablePcapAll(), ns3::PcapHelperForIpv4::EnablePcapIpv4(), ns3::PcapHelperForIpv4::EnablePcapIpv4All(), ns3::PcapHelperForIpv6::EnablePcapIpv6(), ns3::PcapHelperForIpv6::EnablePcapIpv6All(), ns3::MobilityHelper::InstallAll(), ns3::EnergySourceHelper::InstallAll(), and ns3::InternetStackHelper::InstallAll().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetN()

uint32_t ns3::NodeContainer::GetN ( void ) const

Get the number of Ptr<Node> stored in this container.

Nodes can be retrieved from the container in two ways. First, directly by an index into the container, and second, using an iterator. This method is used in the direct method and is typically used to define an ending condition in a for-loop that runs through the stored Nodes

uint32_t nNodes = container.GetN ();
for (uint32_t i = 0 i < nNodes; ++i)
  {
    Ptr<Node> p = container.Get (i)
    i->method ();  // some Node method
  }

Returns: the number of Ptr<Node> stored in this container.

Definition at line 88 of file node-container.cc.

References m_nodes.

Referenced by ns3::CsmaStarHelper::CsmaStarHelper(), ns3::PointToPointStarHelper::PointToPointStarHelper(), ns3::CsmaStarHelper::AssignIpv4Addresses(), ns3::PointToPointStarHelper::AssignIpv4Addresses(), ns3::CsmaStarHelper::AssignIpv6Addresses(), ns3::PointToPointStarHelper::AssignIpv6Addresses(), Experiment::AssignNeighbors(), ns3::PointToPointStarHelper::BoundingBox(), LteCellSelectionTestCase::DoRun(), LteUeMeasurementsHandoverTestCase::DoRun(), LteHandoverTargetTestCase::DoRun(), EpcS1uDlTestCase::DoRun(), EpcS1uUlTestCase::DoRun(), CarrierAggregationConfigTestCase::DoRun(), LenaCqaFfMacSchedulerTestCase1::DoRun(), LenaCqaFfMacSchedulerTestCase2::DoRun(), ns3::LenaDeactivateBearerTestCase::DoRun(), LenaFdTbfqFfMacSchedulerTestCase1::DoRun(), LenaFdTbfqFfMacSchedulerTestCase2::DoRun(), LteDistributedFfrAreaTestCase::DoRun(), LteIpv6RoutingTestCase::DoRun(), LenaPssFfMacSchedulerTestCase1::DoRun(), LenaPssFfMacSchedulerTestCase2::DoRun(), LenaTdTbfqFfMacSchedulerTestCase1::DoRun(), LenaTdTbfqFfMacSchedulerTestCase2::DoRun(), LteEpcE2eDataTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), LteX2HandoverTestCase::DoRun(), CsmaStarTestCase::DoRun(), ns3::PointToPointHelper::Install(), ns3::QKDLinkHelper::InstallQKDControl(), ns3::QKDLinkHelper::InstallQKDEncryptor(), ns3::PointToPointGridHelper::InstallStack(), ns3::PointToPointDumbbellHelper::LeftCount(), ns3::PointToPointDumbbellHelper::RightCount(), NetAnimExperiment::Run(), Experiment::Run(), Experiment::SelectSrcDest(), Experiment::SendMultiDestinations(), ns3::LteHexGridEnbTopologyHelper::SetPositionAndInstallEnbDevice(), ns3::CsmaStarHelper::SpokeCount(), ns3::PointToPointStarHelper::SpokeCount(), and ns3::AnimationInterface::TrackIpv4Route().

Here is the caller graph for this function:

Member Data Documentation

◆ m_nodes

std::vector<Ptr<Node> > ns3::NodeContainer::m_nodes

private

Nodes smart pointers.

Definition at line 314 of file node-container.h.

Referenced by NodeContainer(), Add(), Begin(), Contains(), Create(), End(), Get(), and GetN().

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

src/network/helper/node-container.h
src/network/helper/node-container.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Iterator

Constructor & Destructor Documentation

◆ NodeContainer() [1/8]

◆ NodeContainer() [2/8]

◆ NodeContainer() [3/8]

◆ NodeContainer() [4/8]

◆ NodeContainer() [5/8]

◆ NodeContainer() [6/8]

◆ NodeContainer() [7/8]

◆ NodeContainer() [8/8]

Member Function Documentation

◆ Add() [1/3]

◆ Add() [2/3]

◆ Add() [3/3]

◆ Begin()

◆ Contains()

◆ Create() [1/2]

◆ Create() [2/2]

◆ End()

◆ Get()

◆ GetGlobal()

◆ GetN()

Member Data Documentation

◆ m_nodes