Config system implementation class. More...

Inheritance diagram for ns3::Config::ConfigImpl:

Collaboration diagram for ns3::Config::ConfigImpl:

Public Member Functions
bool	ConnectFailSafe (std::string path, const CallbackBase &cb)

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

void	Disconnect (std::string path, const CallbackBase &cb)

void	DisconnectWithoutContext (std::string path, const CallbackBase &cb)

Ptr< Object >	GetRootNamespaceObject (std::size_t i) const

std::size_t	GetRootNamespaceObjectN () const

MatchContainer	LookupMatches (std::string path)

void	RegisterRootNamespaceObject (Ptr< Object > obj)

void	Set (std::string path, const AttributeValue &value)

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

void	UnregisterRootNamespaceObject (Ptr< Object > obj)

Public Member Functions inherited from ns3::Singleton< ConfigImpl >
	Singleton (const Singleton< ConfigImpl > &)=delete

Singleton &	operator= (const Singleton< ConfigImpl > &)=delete

Private Types
typedef std::vector< Ptr< Object > >	Roots
	Container type to hold the root Config path tokens.

Private Member Functions
void	ParsePath (std::string path, std::string root, std::string leaf) const
	Break a Config path into the leading path and the last leaf token.

Private Attributes
Roots	m_roots
	The list of Config path roots.

Additional Inherited Members
Static Public Member Functions inherited from ns3::Singleton< ConfigImpl >
static ConfigImpl *	Get ()
	Get a pointer to the singleton instance.

Protected Member Functions inherited from ns3::Singleton< ConfigImpl >
	Singleton ()
	Constructor.

virtual	~Singleton ()
	Destructor.

Detailed Description

Config system implementation class.

Definition at line 629 of file config.cc.

Member Typedef Documentation

◆ Roots

typedef std::vector<Ptr<Object> > ns3::Config::ConfigImpl::Roots

private

Container type to hold the root Config path tokens.

Definition at line 670 of file config.cc.

Member Function Documentation

◆ ConnectFailSafe()

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

Parameters

[in]	path	A path to match trace sources.
[in]	cb	The 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.

Returns: true if any trace sources could be connected.

Definition at line 743 of file config.cc.

References LookupMatches(), NS_LOG_FUNCTION, and ParsePath().

Referenced by ns3::Config::ConnectFailSafe().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConnectWithoutContextFailSafe()

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

Parameters

[in]	path	A path to match trace sources.
[in]	cb	The 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. 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 714 of file config.cc.

References LookupMatches(), NS_LOG_FUNCTION, and ParsePath().

Referenced by ns3::Config::ConnectWithoutContextFailSafe().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Disconnect()

void ns3::Config::ConfigImpl::Disconnect	(	std::string	path,
		const CallbackBase &	cb )

Parameters

[in]	path	A path to match trace sources.
[in]	cb	The callback to connect to the matching trace sources.

This function undoes the work of Config::ConnectWithContext.

Definition at line 755 of file config.cc.

References LookupMatches(), NS_LOG_FUNCTION, NS_LOG_WARN, and ParsePath().

Referenced by ns3::Config::Disconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DisconnectWithoutContext()

void ns3::Config::ConfigImpl::DisconnectWithoutContext	(	std::string	path,
		const CallbackBase &	cb )

Parameters

[in]	path	A path to match trace sources.
[in]	cb	The callback to disconnect to the matching trace sources.

This function undoes the work of Config::Connect.

Definition at line 725 of file config.cc.

References LookupMatches(), NS_LOG_FUNCTION, NS_LOG_WARN, and ParsePath().

Referenced by ns3::Config::DisconnectWithoutContext().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRootNamespaceObject()

Ptr< Object > ns3::Config::ConfigImpl::GetRootNamespaceObject ( std::size_t i ) const

Parameters

[in] i The index of the requested object.

Returns: The requested root namespace object

Definition at line 841 of file config.cc.

References m_roots, and NS_LOG_FUNCTION.

Referenced by ns3::Config::GetRootNamespaceObject().

Here is the caller graph for this function:

◆ GetRootNamespaceObjectN()

std::size_t ns3::Config::ConfigImpl::GetRootNamespaceObjectN ( ) const

Returns: The number of registered root namespace objects.

Definition at line 834 of file config.cc.

References m_roots, and NS_LOG_FUNCTION.

Referenced by ns3::Config::GetRootNamespaceObjectN().

Here is the caller graph for this function:

◆ LookupMatches()

MatchContainer ns3::Config::ConfigImpl::LookupMatches ( std::string path )

Parameters

[in] path The path to perform a match against

Returns: A container which contains all the objects which match the input path.

Definition at line 774 of file config.cc.

References m_roots, and NS_LOG_FUNCTION.

Referenced by ConnectFailSafe(), ConnectWithoutContextFailSafe(), Disconnect(), DisconnectWithoutContext(), ns3::Config::LookupMatches(), Set(), and SetFailSafe().

Here is the caller graph for this function:

◆ ParsePath()

void ns3::Config::ConfigImpl::ParsePath	(	std::string	path,
		std::string *	root,
		std::string *	leaf ) const

private

Break a Config path into the leading path and the last leaf token.

Parameters

[in]	path	The Config path.
[in,out]	root	The leading part of the path , up to the final slash.
[in,out]	leaf	The trailing part of the path .

Definition at line 678 of file config.cc.

References NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ConnectFailSafe(), ConnectWithoutContextFailSafe(), Disconnect(), DisconnectWithoutContext(), Set(), and SetFailSafe().

Here is the caller graph for this function:

◆ RegisterRootNamespaceObject()

void ns3::Config::ConfigImpl::RegisterRootNamespaceObject ( Ptr< Object > obj )

Parameters

[in] obj A new root object

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

Definition at line 812 of file config.cc.

References m_roots, and NS_LOG_FUNCTION.

Referenced by ns3::Config::RegisterRootNamespaceObject().

Here is the caller graph for this function:

◆ Set()

void ns3::Config::ConfigImpl::Set	(	std::string	path,
		const AttributeValue &	value )

Parameters

[in]	path	A path to match attributes.
[in]	value	The 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. If no such attributes are found, the function will throw a fatal error; use SetFailSafe if the lack of a match is to be permitted.

Definition at line 690 of file config.cc.

References LookupMatches(), NS_LOG_FUNCTION, and ParsePath().

Referenced by ns3::Config::Set().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFailSafe()

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

Parameters

[in]	path	A path to match attributes.
[in]	value	The 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, and will return true if at least one such attribute is found.

Returns: true if any matching attributes could be set.

Definition at line 702 of file config.cc.

References LookupMatches(), NS_LOG_FUNCTION, and ParsePath().

Referenced by ns3::Config::SetFailSafe().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UnregisterRootNamespaceObject()

void ns3::Config::ConfigImpl::UnregisterRootNamespaceObject ( Ptr< Object > obj )

Parameters

[in] obj A new root object

This function undoes the work of Config::RegisterRootNamespaceObject.

Definition at line 819 of file config.cc.

References m_roots, and NS_LOG_FUNCTION.

Referenced by ns3::Config::UnregisterRootNamespaceObject().

Here is the caller graph for this function:

Member Data Documentation

◆ m_roots

Roots ns3::Config::ConfigImpl::m_roots

private

The list of Config path roots.

Definition at line 673 of file config.cc.

Referenced by GetRootNamespaceObject(), GetRootNamespaceObjectN(), LookupMatches(), RegisterRootNamespaceObject(), and UnregisterRootNamespaceObject().

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

src/core/model/config.cc

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Roots

Member Function Documentation

◆ ConnectFailSafe()

◆ ConnectWithoutContextFailSafe()

◆ Disconnect()

◆ DisconnectWithoutContext()

◆ GetRootNamespaceObject()

◆ GetRootNamespaceObjectN()

◆ LookupMatches()

◆ ParsePath()

◆ RegisterRootNamespaceObject()

◆ Set()

◆ SetFailSafe()

◆ UnregisterRootNamespaceObject()

Member Data Documentation

◆ m_roots