A Discrete-Event Network Simulator
API
ns3::NodeContainer Class Reference

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...
 
template<typename... Ts>
 NodeContainer (const NodeContainer &nc, Ts &&... args)
 Create a node container which is a concatenation of multiple 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 (const NodeContainer &nc)
 Append the contents of another NodeContainer to the end of this container. More...
 
template<typename... Ts>
void Add (const NodeContainer &nc, Ts &&... args)
 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< NodeGet (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 ()
 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/5]

ns3::NodeContainer::NodeContainer ( )

Create an empty NodeContainer.

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

◆ NodeContainer() [2/5]

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
nodeThe Ptr<Node> to add to the container.

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

References m_nodes.

◆ NodeContainer() [3/5]

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
nodeNameThe name of the Node Object to add to the container.

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

References m_nodes.

◆ NodeContainer() [4/5]

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

Create a NodeContainer with the requested number of Nodes.

This is syntactic sugar for

nodes.Create (size);
// or nodes.Create (size, systemId);
NodeContainer()
Create an empty NodeContainer.
NodeContainer nodes
Parameters
[in]nThe number of nodes to create.
[in]systemIdThe system id or rank associated with this node

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

References Create(), and m_nodes.

+ Here is the call graph for this function:

◆ NodeContainer() [5/5]

template<typename... Ts>
ns3::NodeContainer::NodeContainer ( const NodeContainer nc,
Ts &&...  args 
)

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

Template Parameters
Ts[deduced] Template type parameter pack for the multiple NodeContainers
Parameters
ncThe first NodeContainer
argsThe remaining NodeContainers
Note
A frequently seen idiom that uses these constructors involves the implicit conversion by constructor of Ptr<Node>. When used, 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 optionally provide arguments of Ptr<Node> to these constructors.

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

References Add(), and trim-trailing-whitespace::args.

+ Here is the call graph for this function:

Member Function Documentation

◆ Add() [1/4]

◆ Add() [2/4]

template<typename... Ts>
void ns3::NodeContainer::Add ( const NodeContainer nc,
Ts &&...  args 
)

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

Template Parameters
Ts[deduced] Template type parameter pack for the multiple NodeContainer
Parameters
ncThe NodeContainer to append
argsThe remaining NodeContainers to append

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

References Add(), and trim-trailing-whitespace::args.

+ Here is the call graph for this function:

◆ Add() [3/4]

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

Append a single Ptr<Node> to this container.

Parameters
nodeThe Ptr<Node> to append.

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

References m_nodes.

◆ Add() [4/4]

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
nodeNameThe name of the Node Object to add to the container.

Definition at line 116 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

for (i = container.Begin (); i != container.End (); ++i)
{
(*i)->method (); // some Node method
}
std::vector< Ptr< Node > >::const_iterator Iterator
Node container iterator.
Returns
an iterator which refers to the first Node in the container.

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

References m_nodes.

Referenced by ns3::SameRoomPositionAllocator::SameRoomPositionAllocator(), Add(), ns3::LteHelper::AddX2Interface(), ns3::AodvHelper::AssignStreams(), ns3::OnOffHelper::AssignStreams(), ns3::InternetStackHelper::AssignStreams(), ns3::RipHelper::AssignStreams(), ns3::RipNgHelper::AssignStreams(), ns3::GroupMobilityHelper::AssignStreams(), ns3::MobilityHelper::AssignStreams(), ns3::OlsrHelper::AssignStreams(), ns3::WaveBsmHelper::AssignStreams(), ns3::DistributedSimulatorImpl::CalculateLookAhead(), ns3::NullMessageSimulatorImpl::CalculateLookAhead(), LteCellSelectionTestCase::DoRun(), RandomRoomPositionAllocatorTestCase::DoRun(), SameRoomPositionAllocatorTestCase::DoRun(), Ipv4DeduplicationTest::DoRun(), Ipv4DeduplicationPerformanceTest::DoRun(), SixlowpanIphcStatefulImplTest::DoRun(), ns3::MobilityHelper::EnableAscii(), ns3::UanHelper::EnableAscii(), ns3::AsciiTraceHelperForDevice::EnableAsciiImpl(), ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4Impl(), ns3::AsciiTraceHelperForIpv6::EnableAsciiIpv6Impl(), ns3::AthstatsHelper::EnableAthstats(), ns3::PcapHelperForDevice::EnablePcap(), ns3::PcapHelperForIpv4::EnablePcapIpv4(), ns3::PcapHelperForIpv6::EnablePcapIpv6(), ns3::SameRoomPositionAllocator::GetNext(), ns3::FdNetDeviceHelper::Install(), ns3::CsmaHelper::Install(), ns3::SimpleNetDeviceHelper::Install(), ns3::WaveHelper::Install(), ns3::WifiHelper::Install(), ns3::MeshHelper::Install(), ns3::UdpServerHelper::Install(), ns3::UdpClientHelper::Install(), ns3::UdpTraceClientHelper::Install(), ns3::BuildingsHelper::Install(), ns3::Ping6Helper::Install(), ns3::LrWpanHelper::Install(), ns3::BulkSendHelper::Install(), ns3::OnOffHelper::Install(), ns3::PacketSinkHelper::Install(), ns3::ThreeGppHttpClientHelper::Install(), ns3::ThreeGppHttpServerHelper::Install(), ns3::UdpEchoServerHelper::Install(), ns3::UdpEchoClientHelper::Install(), ns3::EnergySourceHelper::Install(), ns3::InternetStackHelper::Install(), ns3::PacketSocketHelper::Install(), ns3::AdhocAlohaNoackIdealPhyHelper::Install(), ns3::SpectrumAnalyzerHelper::Install(), ns3::WaveformGeneratorHelper::Install(), ns3::WimaxHelper::Install(), ns3::UanHelper::Install(), ns3::GroupMobilityHelper::Install(), ns3::MobilityHelper::Install(), ns3::TvSpectrumTransmitterHelper::Install(), ns3::V4PingHelper::Install(), ns3::V4TraceRouteHelper::Install(), ns3::TvSpectrumTransmitterHelper::InstallAdjacent(), ns3::LteHelper::InstallEnbDevice(), ns3::LteSimpleHelper::InstallEnbDevice(), ns3::LteHelper::InstallUeDevice(), ns3::LteSimpleHelper::InstallUeDevice(), UanExperiment::SendPackets(), UanExperiment::SetupApplications(), UanExperiment::SetupCommunications(), ns3::AnimationInterface::TrackIpv4Route(), NetAnimExperiment::UpdatePositions(), and Experiment::UpdatePositions().

◆ Contains()

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

Return true if container contains a Node with index id.

Parameters
idNode Id
Returns
whether the NodeContainer contains a node with index id

Definition at line 123 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
nThe number of Nodes to create

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

References m_nodes.

Referenced by ns3::CsmaStarHelper::CsmaStarHelper(), NodeContainer(), ns3::PointToPointDumbbellHelper::PointToPointDumbbellHelper(), ns3::PointToPointGridHelper::PointToPointGridHelper(), ns3::PointToPointStarHelper::PointToPointStarHelper(), ns3::BriteTopologyHelper::BuildBriteTopology(), VanetRoutingExperiment::ConfigureNodes(), BatteryLifetimeTest::ConstantLoadTest(), AodvExample::CreateNodes(), ChainRegressionTest::CreateNodes(), Bug772ChainTest::CreateNodes(), DsdvManetExample::CreateNodes(), TracerouteExample::CreateNodes(), MeshTest::CreateNodes(), HwmpProactiveRegressionTest::CreateNodes(), HwmpReactiveRegressionTest::CreateNodes(), HwmpSimplestRegressionTest::CreateNodes(), HwmpDoRfRegressionTest::CreateNodes(), PeerManagementProtocolRegressionTest::CreateNodes(), FlameRegressionTest::CreateNodes(), Ns2MobilityHelperTest::CreateNodes(), ns3::olsr::Bug780Test::CreateNodes(), ns3::olsr::HelloRegressionTest::CreateNodes(), ns3::olsr::TcRegressionTest::CreateNodes(), WaveNetDeviceExample::CreateWaveNodes(), TestCaseHelper::CreatWaveDevice(), BasicEnergyDepletionTest::DepletionTestCase(), LteCellSelectionTestCase::DoRun(), LtePrimaryCellChangeTestCase::DoRun(), LteRadioLinkFailureTestCase::DoRun(), LteSecondaryCellSelectionTestCase::DoRun(), LteUeMeasurementsPiecewiseTestCase1::DoRun(), LteUeMeasurementsPiecewiseTestCase2::DoRun(), LteUeMeasurementsPiecewiseTestCase3::DoRun(), LteUeMeasurementsHandoverTestCase::DoRun(), LteHandoverTargetTestCase::DoRun(), UdpClientServerTestCase::DoRun(), UdpTraceClientServerTestCase::DoRun(), UdpEchoClientSetFillTestCase::DoRun(), BriteTopologyFunctionTestCase::DoRun(), RandomRoomPositionAllocatorTestCase::DoRun(), SameRoomPositionAllocatorTestCase::DoRun(), BuildingsChannelConditionModelTestCase::DoRun(), BuildingsHelperOneTestCase::DoRun(), OutdoorRandomWalkTestCase::DoRun(), ThreeGppV2vBuildingsChCondModelTestCase::DoRun(), ThreeGppV2vUrbanLosNlosvChCondModelTestCase::DoRun(), ThreeGppV2vHighwayLosNlosvChCondModelTestCase::DoRun(), DhcpTestCase::DoRun(), IcmpEchoReplyTestCase::DoRun(), IcmpTimeExceedTestCase::DoRun(), IcmpV6EchoReplyTestCase::DoRun(), IcmpV6TimeExceedTestCase::DoRun(), Ipv4DeduplicationTest::DoRun(), Ipv4DeduplicationPerformanceTest::DoRun(), Ipv4DynamicGlobalRoutingTestCase::DoRun(), IpAddressHelperTestCasev6::DoRun(), ChannelTest::DoRun(), NetDeviceContainerTest::DoRun(), InterfaceContainerTest::DoRun(), FlushTest::DoRun(), DuplicateTest::DoRun(), DynamicPartialTest::DoRun(), ns3::TcpGeneralTest::DoRun(), EpcS1uDlTestCase::DoRun(), EpcS1uUlTestCase::DoRun(), CarrierAggregationConfigTestCase::DoRun(), CarrierAggregationTestCase::DoRun(), LenaCqaFfMacSchedulerTestCase1::DoRun(), LenaCqaFfMacSchedulerTestCase2::DoRun(), LteCqiGenerationTestCase::DoRun(), LteCqiGenerationDlPowerControlTestCase::DoRun(), ns3::LenaDeactivateBearerTestCase::DoRun(), LteDownlinkPowerControlTestCase::DoRun(), LteDownlinkPowerControlRrcConnectionReconfigurationTestCase::DoRun(), LenaFdBetFfMacSchedulerTestCase1::DoRun(), LenaFdBetFfMacSchedulerTestCase2::DoRun(), LenaFdMtFfMacSchedulerTestCase::DoRun(), LenaFdTbfqFfMacSchedulerTestCase1::DoRun(), LenaFdTbfqFfMacSchedulerTestCase2::DoRun(), LteHardFrTestCase::DoRun(), LteStrictFrTestCase::DoRun(), LteStrictFrAreaTestCase::DoRun(), LteSoftFrAreaTestCase::DoRun(), LteSoftFfrAreaTestCase::DoRun(), LteEnhancedFfrAreaTestCase::DoRun(), LteDistributedFfrAreaTestCase::DoRun(), LenaHarqTestCase::DoRun(), LteInterferenceHardFrTestCase::DoRun(), LteInterferenceStrictFrTestCase::DoRun(), LteInterferenceTestCase::DoRun(), LteIpv6RoutingTestCase::DoRun(), LteLinkAdaptationTestCase::DoRun(), LenaMimoTestCase::DoRun(), LtePathlossModelSystemTestCase::DoRun(), LenaPfFfMacSchedulerTestCase1::DoRun(), LenaPfFfMacSchedulerTestCase2::DoRun(), LenaDataPhyErrorModelTestCase::DoRun(), LenaDlCtrlPhyErrorModelTestCase::DoRun(), LenaPssFfMacSchedulerTestCase1::DoRun(), LenaPssFfMacSchedulerTestCase2::DoRun(), LteRlcAmE2eTestCase::DoRun(), LteRlcUmE2eTestCase::DoRun(), LenaRrFfMacSchedulerTestCase::DoRun(), LenaTdBetFfMacSchedulerTestCase1::DoRun(), LenaTdBetFfMacSchedulerTestCase2::DoRun(), LenaTdMtFfMacSchedulerTestCase::DoRun(), LenaTdTbfqFfMacSchedulerTestCase1::DoRun(), LenaTdTbfqFfMacSchedulerTestCase2::DoRun(), LenaTtaFfMacSchedulerTestCase::DoRun(), LteUeMeasurementsTestCase::DoRun(), LteUplinkOpenLoopPowerControlTestCase::DoRun(), LteUplinkClosedLoopPowerControlAbsoluteModeTestCase::DoRun(), LteUplinkClosedLoopPowerControlAccumulatedModeTestCase::DoRun(), LteEnbAntennaTestCase::DoRun(), LteEpcE2eDataTestCase::DoRun(), LteHandoverDelayTestCase::DoRun(), LteRrcConnectionEstablishmentTestCase::DoRun(), LteRrcConnectionEstablishmentErrorTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), LteX2HandoverTestCase::DoRun(), WaypointMobilityModelViaHelper::DoRun(), MobilityTraceTestCase::DoRun(), PacketSocketAppsTest::DoRun(), NixVectorRoutingTest::DoRun(), ThreeGppChannelConditionModelTestCase::DoRun(), V2vUrbanProbChCondModelTestCase::DoRun(), V2vHighwayProbChCondModelTestCase::DoRun(), ThreeGppRmaPropagationLossModelTestCase::DoRun(), ThreeGppUmaPropagationLossModelTestCase::DoRun(), ThreeGppUmiPropagationLossModelTestCase::DoRun(), ThreeGppIndoorOfficePropagationLossModelTestCase::DoRun(), ThreeGppV2vUrbanPropagationLossModelTestCase::DoRun(), ThreeGppV2vHighwayPropagationLossModelTestCase::DoRun(), SixlowpanIphcStatefulImplTest::DoRun(), SpectrumIdealPhyTestCase::DoRun(), ThreeGppChannelMatrixComputationTest::DoRun(), ThreeGppChannelMatrixUpdateTest::DoRun(), ThreeGppSpectrumPropagationLossModelTest::DoRun(), CsmaBridgeTestCase::DoRun(), CsmaBroadcastTestCase::DoRun(), CsmaMulticastTestCase::DoRun(), CsmaOneSubnetTestCase::DoRun(), CsmaPacketSocketTestCase::DoRun(), CsmaPingTestCase::DoRun(), CsmaRawIpSocketTestCase::DoRun(), CsmaStarTestCase::DoRun(), Ns3TcpLossTestCase::DoRun(), Ns3TcpSocketTestCaseCsma::DoRun(), Ns3TcpStateTestCase::DoRun(), WifiAcMappingTest::DoRun(), Issue211Test::DoRun(), WifiMsduAggregatorThroughputTest::DoRun(), TcFlowControlTestCase::DoRun(), OcbWifiMacTestCase::DoRun(), WifiChannelSwitchingTest::DoRun(), MultiLinkSetupTest::DoRun(), Ns3WimaxNetworkEntryTestCase::DoRun(), Ns3WimaxManagementConnectionsTestCase::DoRun(), Ns3WimaxSfCreationTestCase::DoRun(), BlockAckAggregationDisabledTest::DoRun(), PreservePacketsInAmpdus::DoRun(), Bug730TestCase::DoRun(), QosFragmentationTestCase::DoRun(), SetChannelFrequencyTest::DoRun(), Bug2222TestCase::DoRun(), Bug2843TestCase::DoRun(), Issue169TestCase::DoRun(), IdealRateManagerChannelWidthTest::DoRun(), IdealRateManagerMimoTest::DoRun(), Ns3WimaxSimpleOFDMTestCase::DoRunOnce(), Ns3WimaxSFTypeTestCase::DoRunOnce(), Ns3WimaxSchedulingTestCase::DoRunOnce(), LinkTest::DoSetup(), LanTest::DoSetup(), TwoLinkTest::DoSetup(), TwoLanTest::DoSetup(), BridgeTest::DoSetup(), TwoBridgeTest::DoSetup(), TestUlOfdmaPowerControl::DoSetup(), WifiPrimaryChannelsTest::DoSetup(), experiment(), ns3::TvSpectrumTransmitterHelper::InstallRandomRegionalTransmitters(), UanExperiment::Prepare(), AnimationInterfaceTestCase::PrepareNetwork(), AnimationRemainingEnergyTestCase::PrepareNetwork(), NeighborCacheExample::Run(), Experiment::Run(), RoutingExperiment::Run(), NetAnimExperiment::Run(), TestInterBssConstantObssPdAlgo::RunOne(), Issue40TestCase::RunOne(), Bug2470TestCase::RunSubtest(), TbfQueueDiscTestCase::RunTbfTest(), ThreeGppShadowingTestCase::RunTest(), StaWifiMacScanningTestCase::Setup(), and BatteryLifetimeTest::VariableLoadTest().

◆ 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
nThe number of Nodes to create
systemIdThe system id or rank associated with this node

Definition at line 92 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

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 65 of file node-container.cc.

References m_nodes.

Referenced by ns3::SameRoomPositionAllocator::SameRoomPositionAllocator(), Add(), ns3::LteHelper::AddX2Interface(), ns3::AodvHelper::AssignStreams(), ns3::OnOffHelper::AssignStreams(), ns3::InternetStackHelper::AssignStreams(), ns3::RipHelper::AssignStreams(), ns3::RipNgHelper::AssignStreams(), ns3::GroupMobilityHelper::AssignStreams(), ns3::MobilityHelper::AssignStreams(), ns3::OlsrHelper::AssignStreams(), ns3::WaveBsmHelper::AssignStreams(), ns3::DistributedSimulatorImpl::CalculateLookAhead(), ns3::NullMessageSimulatorImpl::CalculateLookAhead(), LteCellSelectionTestCase::DoRun(), RandomRoomPositionAllocatorTestCase::DoRun(), SameRoomPositionAllocatorTestCase::DoRun(), Ipv4DeduplicationTest::DoRun(), Ipv4DeduplicationPerformanceTest::DoRun(), SixlowpanIphcStatefulImplTest::DoRun(), ns3::MobilityHelper::EnableAscii(), ns3::UanHelper::EnableAscii(), ns3::AsciiTraceHelperForDevice::EnableAsciiImpl(), ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4Impl(), ns3::AsciiTraceHelperForIpv6::EnableAsciiIpv6Impl(), ns3::AthstatsHelper::EnableAthstats(), ns3::PcapHelperForDevice::EnablePcap(), ns3::PcapHelperForIpv4::EnablePcapIpv4(), ns3::PcapHelperForIpv6::EnablePcapIpv6(), ns3::SameRoomPositionAllocator::GetNext(), ns3::FdNetDeviceHelper::Install(), ns3::CsmaHelper::Install(), ns3::SimpleNetDeviceHelper::Install(), ns3::WaveHelper::Install(), ns3::WifiHelper::Install(), ns3::MeshHelper::Install(), ns3::UdpServerHelper::Install(), ns3::UdpClientHelper::Install(), ns3::UdpTraceClientHelper::Install(), ns3::BuildingsHelper::Install(), ns3::Ping6Helper::Install(), ns3::LrWpanHelper::Install(), ns3::BulkSendHelper::Install(), ns3::OnOffHelper::Install(), ns3::PacketSinkHelper::Install(), ns3::ThreeGppHttpClientHelper::Install(), ns3::ThreeGppHttpServerHelper::Install(), ns3::UdpEchoServerHelper::Install(), ns3::UdpEchoClientHelper::Install(), ns3::EnergySourceHelper::Install(), ns3::InternetStackHelper::Install(), ns3::PacketSocketHelper::Install(), ns3::AdhocAlohaNoackIdealPhyHelper::Install(), ns3::SpectrumAnalyzerHelper::Install(), ns3::WaveformGeneratorHelper::Install(), ns3::WimaxHelper::Install(), ns3::UanHelper::Install(), ns3::GroupMobilityHelper::Install(), ns3::MobilityHelper::Install(), ns3::TvSpectrumTransmitterHelper::Install(), ns3::V4PingHelper::Install(), ns3::V4TraceRouteHelper::Install(), ns3::TvSpectrumTransmitterHelper::InstallAdjacent(), ns3::LteHelper::InstallEnbDevice(), ns3::LteSimpleHelper::InstallEnbDevice(), ns3::LteHelper::InstallUeDevice(), ns3::LteSimpleHelper::InstallUeDevice(), UanExperiment::SendPackets(), UanExperiment::SetupApplications(), UanExperiment::SetupCommunications(), ns3::AnimationInterface::TrackIpv4Route(), NetAnimExperiment::UpdatePositions(), and Experiment::UpdatePositions().

◆ 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<Node>.

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
ithe index of the requested node pointer.
Returns
the requested node pointer.

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

References m_nodes.

Referenced by ns3::CsmaStarHelper::CsmaStarHelper(), ns3::PointToPointDumbbellHelper::PointToPointDumbbellHelper(), ns3::PointToPointGridHelper::PointToPointGridHelper(), ns3::PointToPointStarHelper::PointToPointStarHelper(), Experiment::AssignNeighbors(), ns3::PointToPointStarHelper::BoundingBox(), BuildAppsTest(), AnimationRemainingEnergyTestCase::CheckLogic(), ns3::BriteTopologyHelper::ConstructTopology(), ChainRegressionTest::CreateDevices(), Bug772ChainTest::CreateDevices(), AodvExample::CreateNodes(), TracerouteExample::CreateNodes(), Ns2MobilityHelperTest::CreateNodes(), ns3::olsr::Bug780Test::CreateNodes(), ns3::olsr::HelloRegressionTest::CreateNodes(), ns3::olsr::TcRegressionTest::CreateNodes(), ChainRegressionTest::DoRun(), LteCellSelectionTestCase::DoRun(), LteRadioLinkFailureTestCase::DoRun(), LteUeMeasurementsPiecewiseTestCase1::DoRun(), LteUeMeasurementsPiecewiseTestCase2::DoRun(), LteUeMeasurementsPiecewiseTestCase3::DoRun(), LteUeMeasurementsHandoverTestCase::DoRun(), LteHandoverTargetTestCase::DoRun(), BulkSendBasicTestCase::DoRun(), BulkSendSeqTsSizeTestCase::DoRun(), UdpClientServerTestCase::DoRun(), UdpTraceClientServerTestCase::DoRun(), UdpEchoClientSetFillTestCase::DoRun(), BriteTopologyFunctionTestCase::DoRun(), BuildingsChannelConditionModelTestCase::DoRun(), BuildingsHelperOneTestCase::DoRun(), OutdoorRandomWalkTestCase::DoRun(), ThreeGppV2vBuildingsChCondModelTestCase::DoRun(), ThreeGppV2vUrbanLosNlosvChCondModelTestCase::DoRun(), ThreeGppV2vHighwayLosNlosvChCondModelTestCase::DoRun(), IcmpEchoReplyTestCase::DoRun(), IcmpTimeExceedTestCase::DoRun(), IcmpV6EchoReplyTestCase::DoRun(), IcmpV6TimeExceedTestCase::DoRun(), Ipv4DeduplicationTest::DoRun(), LinkTest::DoRun(), LanTest::DoRun(), TwoLinkTest::DoRun(), TwoLanTest::DoRun(), BridgeTest::DoRun(), TwoBridgeTest::DoRun(), Ipv4DynamicGlobalRoutingTestCase::DoRun(), IpAddressHelperTestCasev6::DoRun(), ChannelTest::DoRun(), NetDeviceContainerTest::DoRun(), InterfaceContainerTest::DoRun(), FlushTest::DoRun(), DuplicateTest::DoRun(), DynamicPartialTest::DoRun(), ns3::TcpGeneralTest::DoRun(), EpcS1uDlTestCase::DoRun(), EpcS1uUlTestCase::DoRun(), CarrierAggregationConfigTestCase::DoRun(), CarrierAggregationTestCase::DoRun(), LenaCqaFfMacSchedulerTestCase1::DoRun(), LenaCqaFfMacSchedulerTestCase2::DoRun(), LteCqiGenerationTestCase::DoRun(), ns3::LenaDeactivateBearerTestCase::DoRun(), LenaFdBetFfMacSchedulerTestCase1::DoRun(), LenaFdBetFfMacSchedulerTestCase2::DoRun(), LenaFdMtFfMacSchedulerTestCase::DoRun(), LenaFdTbfqFfMacSchedulerTestCase1::DoRun(), LenaFdTbfqFfMacSchedulerTestCase2::DoRun(), LteStrictFrAreaTestCase::DoRun(), LteSoftFrAreaTestCase::DoRun(), LteSoftFfrAreaTestCase::DoRun(), LteEnhancedFfrAreaTestCase::DoRun(), LteDistributedFfrAreaTestCase::DoRun(), LenaHarqTestCase::DoRun(), LteInterferenceHardFrTestCase::DoRun(), LteInterferenceStrictFrTestCase::DoRun(), LteIpv6RoutingTestCase::DoRun(), LenaMimoTestCase::DoRun(), LtePathlossModelSystemTestCase::DoRun(), LenaPfFfMacSchedulerTestCase1::DoRun(), LenaPfFfMacSchedulerTestCase2::DoRun(), LenaDataPhyErrorModelTestCase::DoRun(), LenaDlCtrlPhyErrorModelTestCase::DoRun(), LenaPssFfMacSchedulerTestCase1::DoRun(), LenaPssFfMacSchedulerTestCase2::DoRun(), LenaRrFfMacSchedulerTestCase::DoRun(), LenaTdBetFfMacSchedulerTestCase1::DoRun(), LenaTdBetFfMacSchedulerTestCase2::DoRun(), LenaTdMtFfMacSchedulerTestCase::DoRun(), LenaTdTbfqFfMacSchedulerTestCase1::DoRun(), LenaTdTbfqFfMacSchedulerTestCase2::DoRun(), LenaTtaFfMacSchedulerTestCase::DoRun(), LteUplinkOpenLoopPowerControlTestCase::DoRun(), LteUplinkClosedLoopPowerControlAbsoluteModeTestCase::DoRun(), LteUplinkClosedLoopPowerControlAccumulatedModeTestCase::DoRun(), LteEpcE2eDataTestCase::DoRun(), LteRrcConnectionEstablishmentErrorTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), LteX2HandoverTestCase::DoRun(), WaypointMobilityModelViaHelper::DoRun(), PacketSocketAppsTest::DoRun(), NixVectorRoutingTest::DoRun(), ThreeGppChannelConditionModelTestCase::DoRun(), V2vUrbanProbChCondModelTestCase::DoRun(), V2vHighwayProbChCondModelTestCase::DoRun(), ThreeGppRmaPropagationLossModelTestCase::DoRun(), ThreeGppUmaPropagationLossModelTestCase::DoRun(), ThreeGppUmiPropagationLossModelTestCase::DoRun(), ThreeGppIndoorOfficePropagationLossModelTestCase::DoRun(), ThreeGppV2vUrbanPropagationLossModelTestCase::DoRun(), ThreeGppV2vHighwayPropagationLossModelTestCase::DoRun(), SixlowpanIphcStatefulImplTest::DoRun(), SpectrumIdealPhyTestCase::DoRun(), ThreeGppChannelMatrixComputationTest::DoRun(), ThreeGppChannelMatrixUpdateTest::DoRun(), ThreeGppSpectrumPropagationLossModelTest::DoRun(), CsmaBridgeTestCase::DoRun(), CsmaBroadcastTestCase::DoRun(), CsmaMulticastTestCase::DoRun(), CsmaOneSubnetTestCase::DoRun(), CsmaPacketSocketTestCase::DoRun(), CsmaPingTestCase::DoRun(), CsmaRawIpSocketTestCase::DoRun(), CsmaStarTestCase::DoRun(), Ns3TcpLossTestCase::DoRun(), Ns3TcpSocketTestCaseCsma::DoRun(), Ns3TcpStateTestCase::DoRun(), WifiAcMappingTest::DoRun(), Issue211Test::DoRun(), WifiMsduAggregatorThroughputTest::DoRun(), TcFlowControlTestCase::DoRun(), OcbWifiMacTestCase::DoRun(), BlockAckAggregationDisabledTest::DoRun(), PreservePacketsInAmpdus::DoRun(), WifiUseAvailBwTest::DoRun(), Bug730TestCase::DoRun(), QosFragmentationTestCase::DoRun(), SetChannelFrequencyTest::DoRun(), Bug2222TestCase::DoRun(), StaWifiMacScanningTestCase::DoRun(), TwoLinkTest::DoSetup(), TwoLanTest::DoSetup(), BridgeTest::DoSetup(), TwoBridgeTest::DoSetup(), TestUlOfdmaPowerControl::DoSetup(), WifiPrimaryChannelsTest::DoSetup(), experiment(), Experiment::GenerateNeighbors(), OcbWifiMacTestCase::GetCurrentPosition(), ns3::CsmaStarHelper::GetHub(), ns3::PointToPointStarHelper::GetHub(), ns3::PointToPointDumbbellHelper::GetLeft(), ns3::PointToPointDumbbellHelper::GetRight(), ns3::CsmaStarHelper::GetSpokeNode(), ns3::PointToPointStarHelper::GetSpokeNode(), ns3::PointToPointHelper::Install(), MeshTest::InstallApplication(), AodvExample::InstallApplications(), DsdvManetExample::InstallApplications(), TracerouteExample::InstallApplications(), HwmpProactiveRegressionTest::InstallApplications(), HwmpReactiveRegressionTest::InstallApplications(), HwmpSimplestRegressionTest::InstallApplications(), HwmpDoRfRegressionTest::InstallApplications(), FlameRegressionTest::InstallApplications(), ns3::PointToPointGridHelper::InstallStack(), AnimationInterfaceTestCase::PrepareNetwork(), AnimationRemainingEnergyTestCase::PrepareNetwork(), HwmpReactiveRegressionTest::ResetPosition(), HwmpSimplestRegressionTest::ResetPosition(), NeighborCacheExample::Run(), Experiment::Run(), RoutingExperiment::Run(), NetAnimExperiment::Run(), TestInterBssConstantObssPdAlgo::RunOne(), Issue40TestCase::RunOne(), TbfQueueDiscTestCase::RunTbfTest(), ThreeGppShadowingTestCase::RunTest(), Experiment::SelectSrcDest(), Experiment::SendMultiDestinations(), WifiChannelSwitchingTest::SendPacket(), ns3::LteHexGridEnbTopologyHelper::SetPositionAndInstallEnbDevice(), UanExperiment::SetupPositions(), RoutingHelper::SetupRoutingMessages(), and UpdateAnimation().

◆ 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 NodeContainer which contains a list of all Nodes.

Definition at line 27 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 71 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(), Ipv4DeduplicationPerformanceTest::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(), RocketfuelTopologyReaderWeightsTest::DoRun(), RocketfuelTopologyReaderMapsTest::DoRun(), ns3::PointToPointHelper::Install(), 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(), ns3::AnimationInterface::TrackIpv4Route(), and UpdateAnimation().

+ 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 272 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: