ns-3
ns3::Config::MatchContainer Class Reference

hold a set of objects which match a specific search string. More...

#include <config.h>

List of all members.

Public Types

typedef std::vector< Ptr
< Object > >::const_iterator 
Iterator

Public Member Functions

 MatchContainer (const std::vector< Ptr< Object > > &objects, const std::vector< std::string > &contexts, std::string path)
MatchContainer::Iterator Begin (void) const
MatchContainer::Iterator End (void) const
uint32_t GetN (void) const
Ptr< ObjectGet (uint32_t i) const
std::string GetMatchedPath (uint32_t i) const
std::string GetPath (void) const
void Set (std::string name, const AttributeValue &value)
void Connect (std::string name, const CallbackBase &cb)
void ConnectWithoutContext (std::string name, const CallbackBase &cb)
void Disconnect (std::string name, const CallbackBase &cb)
void DisconnectWithoutContext (std::string name, const CallbackBase &cb)

Detailed Description

hold a set of objects which match a specific search string.

This class also allows you to perform a set of configuration operations on the set of matching objects stored in the container. Specifically, it is possible to perform bulk Connects and Sets.


Member Function Documentation

MatchContainer::Iterator ns3::Config::MatchContainer::Begin ( void  ) const
Returns:
an iterator which points to the first item in the container

Referenced by ConnectWithoutContext(), DisconnectWithoutContext(), and Set().

void ns3::Config::MatchContainer::Connect ( std::string  name,
const CallbackBase cb 
)
Parameters:
namethe name of the trace source to connect to
cbthe sink to connect to the trace source

Connect the specified sink to all the objects stored in this container.

See also:
ns3::Config::Connect

References NS_ASSERT.

void ns3::Config::MatchContainer::ConnectWithoutContext ( std::string  name,
const CallbackBase cb 
)
Parameters:
namethe name of the trace source to connect to
cbthe sink to connect to the trace source

Connect the specified sink to all the objects stored in this container.

See also:
ns3::Config::ConnectWithoutContext

References Begin(), End(), and ns3::ObjectBase::TraceConnectWithoutContext().

void ns3::Config::MatchContainer::Disconnect ( std::string  name,
const CallbackBase cb 
)
Parameters:
namethe name of the trace source to disconnect from
cbthe sink to disconnect from the trace source

Disconnect the specified sink from all the objects stored in this container.

See also:
ns3::Config::Disconnect

References NS_ASSERT.

void ns3::Config::MatchContainer::DisconnectWithoutContext ( std::string  name,
const CallbackBase cb 
)
Parameters:
namethe name of the trace source to disconnect from
cbthe sink to disconnect from the trace source

Disconnect the specified sink from all the objects stored in this container.

See also:
ns3::Config::DisconnectWithoutContext

References Begin(), End(), and ns3::ObjectBase::TraceDisconnectWithoutContext().

MatchContainer::Iterator ns3::Config::MatchContainer::End ( void  ) const
Returns:
an iterator which points to the last item in the container

Referenced by ConnectWithoutContext(), DisconnectWithoutContext(), and Set().

Ptr< Object > ns3::Config::MatchContainer::Get ( uint32_t  i) const
Parameters:
iindex of item to lookup ([0,n[)
Returns:
the item requested.
std::string ns3::Config::MatchContainer::GetMatchedPath ( uint32_t  i) const
Parameters:
iindex of item to lookup ([0,n[)
Returns:
the fully-qualified matching path associated to the requested item.

The matching patch uniquely identifies the requested object.

uint32_t ns3::Config::MatchContainer::GetN ( void  ) const
Returns:
the number of items in the container
std::string ns3::Config::MatchContainer::GetPath ( void  ) const
Returns:
the path used to perform the object matching.
void ns3::Config::MatchContainer::Set ( std::string  name,
const AttributeValue value 
)
Parameters:
namename of attribute to set
valuevalue to set to the attribute

Set the specified attribute value to all the objects stored in this container.

See also:
ns3::Config::Set

References Begin(), End(), and ns3::ObjectBase::SetAttribute().


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