Classes | Functions

ns3::Config Namespace Reference
[Core]

Configuration of simulation parameters and tracing. More...

Classes

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

Functions

void Set (std::string path, const AttributeValue &value)
void SetDefault (std::string name, const AttributeValue &value)
bool SetDefaultFailSafe (std::string name, const AttributeValue &value)
void SetGlobal (std::string name, const AttributeValue &value)
bool SetGlobalFailSafe (std::string name, const AttributeValue &value)
void ConnectWithoutContext (std::string path, const CallbackBase &cb)
void DisconnectWithoutContext (std::string path, const CallbackBase &cb)
void Connect (std::string path, const CallbackBase &cb)
void Disconnect (std::string path, const CallbackBase &cb)
MatchContainer LookupMatches (std::string path)
void RegisterRootNamespaceObject (Ptr< Object > obj)
void UnregisterRootNamespaceObject (Ptr< Object > obj)
uint32_t GetRootNamespaceObjectN (void)
Ptr< ObjectGetRootNamespaceObject (uint32_t i)

Detailed Description

Configuration of simulation parameters and tracing.


Function Documentation

void ns3::Config::Connect ( std::string  path,
const CallbackBase &  cb 
)
Parameters:
patha path to match trace sources.
cbthe callback to connect to the matching trace sources.

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.

void ns3::Config::ConnectWithoutContext ( std::string  path,
const CallbackBase &  cb 
)
Parameters:
patha path to match trace sources.
cbthe callback to connect to the matching trace sources.

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

void ns3::Config::Disconnect ( std::string  path,
const CallbackBase &  cb 
)
Parameters:
patha path to match trace sources.
cbthe callback to connect to the matching trace sources.

This function undoes the work of Config::ConnectWithContext.

void ns3::Config::DisconnectWithoutContext ( std::string  path,
const CallbackBase &  cb 
)
Parameters:
patha path to match trace sources.
cbthe callback to disconnect to the matching trace sources.

This function undoes the work of Config::Connect.

Ptr<Object> ns3::Config::GetRootNamespaceObject ( uint32_t  i )
Parameters:
ithe index of the requested object.
Returns:
the requested root namespace object
uint32_t ns3::Config::GetRootNamespaceObjectN ( void   )
Returns:
the number of registered root namespace objects.
MatchContainer ns3::Config::LookupMatches ( std::string  path )
Parameters:
paththe path to perform a match against
Returns:
a container which contains all the objects which match the input path.
void ns3::Config::RegisterRootNamespaceObject ( Ptr< Object >  obj )
Parameters:
obja new root object

Each root object is used during path matching as the root of the path by Config::Connect, and Config::Set.

void ns3::Config::Set ( std::string  path,
const AttributeValue &  value 
)
Parameters:
patha path to match attributes.
valuethe value to set in all matching attributes.

This function will attempt to find attributes which match the input path and will then set their value to the input value.

void ns3::Config::SetDefault ( std::string  name,
const AttributeValue &  value 
)
Parameters:
namethe full name of the attribute
valuethe value to set.

This method overrides the initial value of the matching attribute. This method cannot fail: it will crash if the input attribute name or value is invalid.

bool ns3::Config::SetDefaultFailSafe ( std::string  name,
const AttributeValue &  value 
)
Parameters:
namethe full name of the attribute
valuethe value to set.
Returns:
true if the value was set successfully, false otherwise.

This method overrides the initial value of the matching attribute.

void ns3::Config::SetGlobal ( std::string  name,
const AttributeValue &  value 
)
Parameters:
namethe name of the requested GlobalValue.
valuethe value to set

This method is equivalent to GlobalValue::Bind

bool ns3::Config::SetGlobalFailSafe ( std::string  name,
const AttributeValue &  value 
)
Parameters:
namethe name of the requested GlobalValue.
valuethe value to set

This method is equivalent to GlobalValue::BindFailSafe

void ns3::Config::UnregisterRootNamespaceObject ( Ptr< Object >  obj )
Parameters:
obja new root object

This function undoes the work of Config::RegisterRootNamespaceObject.