A pool for Ndn faces. More...

#include <ndn-face-container.hpp>

Inheritance diagram for ns3::ndn::FaceContainer:

Collaboration diagram for ns3::ndn::FaceContainer:

Public Types
typedef Container::const_iterator	Iterator
	Iterator over FaceContainer. More...

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

	FaceContainer (const FaceContainer &other)
	Copy constructor for FaceContainer. More...

FaceContainer &	operator= (const FaceContainer &other)
	Copy operator for FaceContainer. More...

void	AddAll (Ptr< FaceContainer > other)
	Add all entries from other container. More...

void	AddAll (const FaceContainer &other)
	Add all entries from other container. More...

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

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

uint32_t	GetN () const
	Get the number of faces stored in this container. More...

void	Add (const shared_ptr< Face > &face)
	Set a metric for all faces in the container. More...

shared_ptr< Face >	Get (Iterator i) const
	Get a smart pointer to Face-derived object stored in the container. More...

Detailed Description

A pool for Ndn faces.

Provides tools to perform basic manipulation on faces, such as setting metrics and states on faces

See also: ndn::StackHelper

Definition at line 44 of file ndn-face-container.hpp.

Member Typedef Documentation

typedef Container::const_iterator ns3::ndn::FaceContainer::Iterator

Iterator over FaceContainer.

Definition at line 49 of file ndn-face-container.hpp.

Constructor & Destructor Documentation

ns3::ndn::FaceContainer::FaceContainer ( )

Create an empty FaceContainer.

Definition at line 27 of file ndn-face-container.cpp.

ns3::ndn::FaceContainer::FaceContainer ( const FaceContainer & other )

Copy constructor for FaceContainer.

Calls AddAll method

See also: FaceContainer::AddAll

Definition at line 31 of file ndn-face-container.cpp.

References AddAll().

Member Function Documentation

void ns3::ndn::FaceContainer::Add ( const shared_ptr< Face > & face )

Set a metric for all faces in the container.

Parameters

metric	value of metric to assign to all faces in the container Add an entry to the container
face	a smart pointer to a Face-derived object

See also: Face

Definition at line 87 of file ndn-face-container.cpp.

void ns3::ndn::FaceContainer::AddAll ( Ptr< FaceContainer > other )

Add all entries from other container.

Parameters

other smart pointer to a container

Definition at line 46 of file ndn-face-container.cpp.

Referenced by FaceContainer(), and operator=().

void ns3::ndn::FaceContainer::AddAll ( const FaceContainer & other )

Add all entries from other container.

Parameters

other container

Definition at line 52 of file ndn-face-container.cpp.

FaceContainer::Iterator ns3::ndn::FaceContainer::Begin ( void ) const

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

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

Definition at line 58 of file ndn-face-container.cpp.

FaceContainer::Iterator ns3::ndn::FaceContainer::End ( void ) const

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

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

Definition at line 64 of file ndn-face-container.cpp.

shared_ptr< Face > ns3::ndn::FaceContainer::Get ( FaceContainer::Iterator i ) const

Get a smart pointer to Face-derived object stored in the container.

Parameters

i	the iterator corresponding to the requested object

This method is redundant and simple dereferencing of the iterator should be used instead

See also: Face

Definition at line 93 of file ndn-face-container.cpp.

uint32_t ns3::ndn::FaceContainer::GetN ( void ) const

Get the number of faces stored in this container.

Returns: the number of faces stored in this container

Definition at line 70 of file ndn-face-container.cpp.

FaceContainer & ns3::ndn::FaceContainer::operator= ( const FaceContainer & other )

Copy operator for FaceContainer.

Empties vector and calls AddAll method

All previously obtained iterators (Begin() and End()) will be invalidated

See also: FaceContainer::AddAll

Definition at line 37 of file ndn-face-container.cpp.

References AddAll().

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

ndnSIM/helper/ndn-face-container.hpp
ndnSIM/helper/ndn-face-container.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation