A Discrete-Event Network Simulator
API
ns3::Config Namespace Reference

Namespace for the various functions implementing the Config system. More...

Classes

class  ArrayMatcher
 Helper to test if an array entry matches a config path specification. More...
 
class  ConfigImpl
 Config system implementation class. More...
 
class  MatchContainer
 hold a set of objects which match a specific search string. More...
 
class  Resolver
 Abstract class to parse Config paths into object references. More...
 

Functions

void Connect (std::string path, const CallbackBase &cb)
 
bool ConnectFailSafe (std::string path, const CallbackBase &cb)
 This function will attempt to find all trace sources which match the input path and will then connect the input callback to them in such a way that the callback will receive an extra context string upon trace event notification. More...
 
void ConnectWithoutContext (std::string path, const CallbackBase &cb)
 
bool ConnectWithoutContextFailSafe (std::string path, const CallbackBase &cb)
 This function will attempt to find all trace sources which match the input path and will then connect the input callback to them. More...
 
void Disconnect (std::string path, const CallbackBase &cb)
 
void DisconnectWithoutContext (std::string path, const CallbackBase &cb)
 
Ptr< ObjectGetRootNamespaceObject (uint32_t i)
 
std::size_t GetRootNamespaceObjectN (void)
 
MatchContainer LookupMatches (std::string path)
 
void RegisterRootNamespaceObject (Ptr< Object > obj)
 
void Reset (void)
 Reset the initial value of every attribute as well as the value of every global to what they were before any call to SetDefault and SetGlobal. More...
 
void Set (std::string path, const AttributeValue &value)
 
void SetDefault (std::string name, const AttributeValue &value)
 
bool SetDefaultFailSafe (std::string name, const AttributeValue &value)
 
bool SetFailSafe (std::string path, const AttributeValue &value)
 This function will attempt to find attributes which match the input path and will then set their value to the input value, and will return true if at least one such attribute is found. More...
 
void SetGlobal (std::string name, const AttributeValue &value)
 
bool SetGlobalFailSafe (std::string name, const AttributeValue &value)
 
void UnregisterRootNamespaceObject (Ptr< Object > obj)
 

Detailed Description

Namespace for the various functions implementing the Config system.

Function Documentation

◆ ConnectFailSafe()

bool ns3::Config::ConnectFailSafe ( std::string  path,
const CallbackBase cb 
)

This function will attempt to find all trace sources which match the input path and will then connect the input callback to them in such a way that the callback will receive an extra context string upon trace event notification.

Returns
true if any trace sources could be connected.

Definition at line 927 of file config.cc.

References ns3::Config::ConfigImpl::ConnectFailSafe(), ns3::Singleton< ConfigImpl >::Get(), and NS_LOG_FUNCTION.

Referenced by Connect(), ns3::AnimationInterface::ConnectCallbacks(), ns3::RadioBearerStatsConnector::ConnectTracesDrbEnb(), ns3::RadioBearerStatsConnector::ConnectTracesDrbUe(), and ns3::PyViz::PyViz().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ConnectWithoutContextFailSafe()

bool ns3::Config::ConnectWithoutContextFailSafe ( std::string  path,
const CallbackBase cb 
)

This function will attempt to find all trace sources which match the input path and will then connect the input callback to them.

If no matching trace sources are found, this method will return false; otherwise true.

Returns
true if any trace sources could be connected.

Definition at line 907 of file config.cc.

References ns3::Config::ConfigImpl::ConnectWithoutContextFailSafe(), ns3::Singleton< ConfigImpl >::Get(), and NS_LOG_FUNCTION.

Referenced by ns3::AnimationInterface::ConnectCallbacks(), ConnectWithoutContext(), ns3::MobilityHelper::EnableAscii(), ns3::Ipv4FlowProbe::Ipv4FlowProbe(), and ns3::Ipv6FlowProbe::Ipv6FlowProbe().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetFailSafe()

bool ns3::Config::SetFailSafe ( std::string  path,
const AttributeValue value 
)

This function will attempt to find attributes which match the input path and will then set their value to the input value, and will return true if at least one such attribute is found.

Returns
true if any matching attributes could be set.

Definition at line 844 of file config.cc.

References ns3::Singleton< ConfigImpl >::Get(), NS_LOG_FUNCTION, and ns3::Config::ConfigImpl::SetFailSafe().

+ Here is the call graph for this function: