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

holds a vector of ns3::Application pointers. More...

#include "application-container.h"

+ Collaboration diagram for ns3::ApplicationContainer:

Public Types

typedef std::vector< Ptr< Application > >::const_iterator Iterator
 Application container iterator. More...
 

Public Member Functions

 ApplicationContainer ()
 Create an empty ApplicationContainer. More...
 
 ApplicationContainer (Ptr< Application > application)
 Create an ApplicationContainer with exactly one application which has been previously instantiated. More...
 
 ApplicationContainer (std::string name)
 Create an ApplicationContainer with exactly one application which has been previously instantiated and assigned a name using the Object Name Service. More...
 
void Add (ApplicationContainer other)
 Append the contents of another ApplicationContainer to the end of this container. More...
 
void Add (Ptr< Application > application)
 Append a single Ptr<Application> to this container. More...
 
void Add (std::string name)
 Append to this container the single Ptr<Application> referred to via its object name service registered name. More...
 
Iterator Begin (void) const
 Get an iterator which refers to the first Application in the container. More...
 
Iterator End (void) const
 Get an iterator which indicates past-the-last Application in the container. More...
 
Ptr< ApplicationGet (uint32_t i) const
 Get the Ptr<Application> stored in this container at a given index. More...
 
uint32_t GetN (void) const
 Get the number of Ptr<Application> stored in this container. More...
 
void Start (Time start)
 Arrange for all of the Applications in this container to Start() at the Time given as a parameter. More...
 
void Stop (Time stop)
 Arrange for all of the Applications in this container to Stop() at the Time given as a parameter. More...
 

Private Attributes

std::vector< Ptr< Application > > m_applications
 Applications smart pointers. More...
 

Detailed Description

holds a vector of ns3::Application pointers.

Typically ns-3 Applications are installed on nodes using an Application helper. The helper Install method takes a NodeContainer which holds some number of Ptr<Node>. For each of the Nodes in the NodeContainer the helper will instantiate an application, install it in a node and add a Ptr<Application> to that application into a Container for use by the caller. This is that container used to hold the Ptr<Application> which are instantiated by the Application helper.

Definition at line 41 of file application-container.h.

Member Typedef Documentation

typedef std::vector<Ptr<Application> >::const_iterator ns3::ApplicationContainer::Iterator

Application container iterator.

Definition at line 68 of file application-container.h.

Constructor & Destructor Documentation

ns3::ApplicationContainer::ApplicationContainer ( )

Create an empty ApplicationContainer.

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

ns3::ApplicationContainer::ApplicationContainer ( Ptr< Application application)

Create an ApplicationContainer with exactly one application which has been previously instantiated.

The single application is specified by a smart pointer.

Parameters
applicationThe Ptr<Application> to add to the container.

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

References m_applications.

ns3::ApplicationContainer::ApplicationContainer ( std::string  name)

Create an ApplicationContainer with exactly one application which has been previously instantiated and assigned a name using the Object Name Service.

This Application is then specified by its assigned name.

Parameters
nameThe name of the Application Object to add to the container.

Definition at line 35 of file application-container.cc.

References m_applications.

Member Function Documentation

void ns3::ApplicationContainer::Add ( Ptr< Application application)

Append a single Ptr<Application> to this container.

Parameters
applicationThe Ptr<Application> to append.

Definition at line 72 of file application-container.cc.

References m_applications.

void ns3::ApplicationContainer::Add ( std::string  name)

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

Parameters
nameThe name of the Application Object to add to the container.

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

References m_applications.

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

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

Applications 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 Applications

for (i = container.Begin (); i != container.End (); ++i)
{
(*i)->method (); // some Application method
}
Returns
an iterator which refers to the first Application in the container.

Definition at line 43 of file application-container.cc.

References m_applications.

Referenced by Add(), ns3::WaveBsmHelper::Install(), Start(), and Stop().

+ Here is the caller graph for this function:

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

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

Applications 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 Applications

for (i = container.Begin (); i != container.End (); ++i)
{
(*i)->method (); // some Application method
}
Returns
an iterator which indicates an ending condition for a loop.

Definition at line 48 of file application-container.cc.

References m_applications.

Referenced by Add(), ns3::WaveBsmHelper::Install(), Start(), and Stop().

+ Here is the caller graph for this function:

Ptr< Application > ns3::ApplicationContainer::Get ( uint32_t  i) const

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

Applications 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 nApplications = container.GetN ();
for (uint32_t i = 0 i < nApplications; ++i)
{
Ptr<Application> p = container.Get (i)
i->method (); // some Application method
}
Parameters
ithe index of the requested application pointer.
Returns
the requested application pointer.

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

References m_applications.

Referenced by WifiMsduAggregatorThroughputTest::DoRun(), WifiAcMappingTest::DoRun(), LteX2HandoverTestCase::DoRun(), BriteTopologyFunctionTestCase::DoRun(), EpcS1uDlTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), LteEpcE2eDataTestCase::DoRun(), UdpEchoClientSetFillTestCase::DoRun(), EpcS1uUlTestCase::DoRun(), GoodputSampling(), and Experiment::Run().

+ Here is the caller graph for this function:

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

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

Applications 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 Applications

uint32_t nApplications = container.GetN ();
for (uint32_t i = 0 i < nApplications; ++i)
{
Ptr<Application> p = container.Get (i)
i->method (); // some Application method
}
Returns
the number of Ptr<Application> stored in this container.

Definition at line 54 of file application-container.cc.

References m_applications.

void ns3::ApplicationContainer::Start ( Time  start)

Arrange for all of the Applications in this container to Start() at the Time given as a parameter.

All Applications need to be provided with a starting simulation time and a stopping simulation time. The ApplicationContainer is a convenient place for allowing all of the contained Applications to be told to wake up and start doing their thing (Start) at a common time.

This method simply iterates through the contained Applications and calls their Start() methods with the provided Time.

Parameters
startThe Time at which each of the applications should start.

Definition at line 84 of file application-container.cc.

References Begin(), End(), and ns3::Application::SetStartTime().

Referenced by Experiment::ApplicationSetup(), BuildAppsTest(), CreateBulkFlow(), CreateOnOffFlow(), WifiMsduAggregatorThroughputTest::DoRun(), ns3::LenaDeactivateBearerTestCase::DoRun(), Ns3TcpNoDelayTestCase::DoRun(), Ns3TcpSocketTestCase1::DoRun(), WifiAcMappingTest::DoRun(), NscTcpLossTestCase1::DoRun(), UdpClientServerTestCase::DoRun(), CsmaBridgeTestCase::DoRun(), LenaCqaFfMacSchedulerTestCase1::DoRun(), LenaPssFfMacSchedulerTestCase1::DoRun(), LenaTdTbfqFfMacSchedulerTestCase1::DoRun(), LenaFdTbfqFfMacSchedulerTestCase1::DoRun(), Ns3TcpLossTestCase::DoRun(), Ns3TcpStateTestCase::DoRun(), LteX2HandoverTestCase::DoRun(), BriteTopologyFunctionTestCase::DoRun(), Ns3TcpInteroperabilityTestCase::DoRun(), LenaTdTbfqFfMacSchedulerTestCase2::DoRun(), EpcS1uDlTestCase::DoRun(), LenaPssFfMacSchedulerTestCase2::DoRun(), LenaCqaFfMacSchedulerTestCase2::DoRun(), LenaFdTbfqFfMacSchedulerTestCase2::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), LteEpcE2eDataTestCase::DoRun(), UdpTraceClientServerTestCase::DoRun(), Ns3TcpSocketTestCase2::DoRun(), NscTcpLossTestCase2::DoRun(), CsmaBroadcastTestCase::DoRun(), Ns3TcpCwndTestCase1::DoRun(), UdpEchoClientSetFillTestCase::DoRun(), CsmaMulticastTestCase::DoRun(), EpcS1uUlTestCase::DoRun(), LteDistributedFfrAreaTestCase::DoRun(), Ns3TcpCwndTestCase2::DoRun(), CsmaOneSubnetTestCase::DoRun(), CsmaPacketSocketTestCase::DoRun(), CsmaPingTestCase::DoRun(), CsmaRawIpSocketTestCase::DoRun(), CsmaStarTestCase::DoRun(), ns3::WaveBsmHelper::Install(), MeshTest::InstallApplication(), DsdvManetExample::InstallApplications(), AodvExample::InstallApplications(), AnimationInterfaceTestCase::PrepareNetwork(), NetAnimExperiment::Run(), Experiment::Run(), RoutingExperiment::Run(), and RoutingHelper::SetupRoutingMessages().

+ Here is the call graph for this function:

void ns3::ApplicationContainer::Stop ( Time  stop)

Arrange for all of the Applications in this container to Stop() at the Time given as a parameter.

All Applications need to be provided with a starting simulation time and a stopping simulation time. The ApplicationContainer is a convenient place for allowing all of the contained Applications to be told to shut down and stop doing their thing (Stop) at a common time.

This method simply iterates through the contained Applications and calls their Stop() methods with the provided Time.

Parameters
stopThe Time at which each of the applications should stop.

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

References Begin(), End(), and ns3::Application::SetStopTime().

Referenced by Experiment::ApplicationSetup(), BuildAppsTest(), CreateBulkFlow(), CreateOnOffFlow(), WifiMsduAggregatorThroughputTest::DoRun(), Ns3TcpNoDelayTestCase::DoRun(), Ns3TcpSocketTestCase1::DoRun(), WifiAcMappingTest::DoRun(), NscTcpLossTestCase1::DoRun(), UdpClientServerTestCase::DoRun(), CsmaBridgeTestCase::DoRun(), Ns3TcpLossTestCase::DoRun(), Ns3TcpStateTestCase::DoRun(), BriteTopologyFunctionTestCase::DoRun(), Ns3TcpInteroperabilityTestCase::DoRun(), EpcS1uDlTestCase::DoRun(), UdpTraceClientServerTestCase::DoRun(), Ns3TcpSocketTestCase2::DoRun(), NscTcpLossTestCase2::DoRun(), CsmaBroadcastTestCase::DoRun(), Ns3TcpCwndTestCase1::DoRun(), UdpEchoClientSetFillTestCase::DoRun(), CsmaMulticastTestCase::DoRun(), EpcS1uUlTestCase::DoRun(), Ns3TcpCwndTestCase2::DoRun(), CsmaOneSubnetTestCase::DoRun(), CsmaPacketSocketTestCase::DoRun(), CsmaPingTestCase::DoRun(), CsmaRawIpSocketTestCase::DoRun(), CsmaStarTestCase::DoRun(), ns3::WaveBsmHelper::Install(), MeshTest::InstallApplication(), DsdvManetExample::InstallApplications(), AodvExample::InstallApplications(), AnimationInterfaceTestCase::PrepareNetwork(), NetAnimExperiment::Run(), Experiment::Run(), and RoutingHelper::SetupRoutingMessages().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

std::vector<Ptr<Application> > ns3::ApplicationContainer::m_applications
private

Applications smart pointers.

Definition at line 213 of file application-container.h.

Referenced by Add(), ApplicationContainer(), Begin(), End(), Get(), and GetN().


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