Configuration of simulation parameters and tracing. More...

Collaboration diagram for Configuration:

Files
file	config-test-suite.cc
	Config test suite.

file	config.cc
	ns3::Config implementations.

file	config.h
	Declaration of the various ns3::Config functions and classes.

file	names-test-suite.cc
	Object Names test suite.

file	names.cc
	ns3::Names, ns3::NamesNode and ns3::NamePriv implementations.

file	names.h
	Declaration of class ns3::Names.

Classes
class	ns3::Config::MatchContainer
	hold a set of objects which match a specific search string. More...

class	ns3::NameNode
	Node in the naming tree. More...

class	ns3::Names
	A directory of name and Ptr<Object> associations that allows us to give any ns3 Object a name. More...

class	ns3::NamesPriv
	The singleton root Names object. More...

Functions
void	ns3::Config::Connect (std::string path, const CallbackBase &cb)

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

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

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

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

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

Ptr< Object >	ns3::Config::GetRootNamespaceObject (uint32_t i)

std::size_t	ns3::Config::GetRootNamespaceObjectN (void)

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

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

void	ns3::Config::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	ns3::Config::Set (std::string path, const AttributeValue &value)

void	ns3::Config::SetDefault (std::string name, const AttributeValue &value)

bool	ns3::Config::SetDefaultFailSafe (std::string name, const AttributeValue &value)

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

void	ns3::Config::SetGlobal (std::string name, const AttributeValue &value)

bool	ns3::Config::SetGlobalFailSafe (std::string name, const AttributeValue &value)

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

Detailed Description

Configuration of simulation parameters and tracing.

Function Documentation

◆ Connect()

void ns3::Config::Connect	(	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. If no matching trace sources are found, this method will throw a fatal error. Use ConnectFailSafe if the absence of matching trace sources should not be fatal.

Definition at line 920 of file config.cc.

References ns3::Config::ConnectFailSafe(), NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ ConnectFailSafe()

bool ns3::Config::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 929 of file config.cc.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConnectWithoutContext()

void ns3::Config::ConnectWithoutContext	(	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 throw a fatal error. Use ConnectWithoutContextFailSafe if the absence of matching trace sources should not be fatal.

Definition at line 901 of file config.cc.

References ns3::Config::ConnectWithoutContextFailSafe(), NS_FATAL_ERROR, and NS_LOG_FUNCTION.

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
	)

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 909 of file config.cc.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Disconnect()

void ns3::Config::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 935 of file config.cc.

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

Referenced by ns3::DoMakeTraceSourceAccessor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DisconnectWithoutContext()

void ns3::Config::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 914 of file config.cc.

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

Referenced by ns3::TracedCallback< Ts >::Disconnect(), and ns3::DoMakeTraceSourceAccessor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRootNamespaceObject()

Ptr< Object > ns3::Config::GetRootNamespaceObject ( uint32_t i )

Parameters

[in] i The index of the requested object.

Returns: The requested root namespace object

Definition at line 964 of file config.cc.

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

Referenced by GetTypicalAggregations(), and ns3::AttributeIterator::Iterate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRootNamespaceObjectN()

std::size_t ns3::Config::GetRootNamespaceObjectN ( void )

Returns: The number of registered root namespace objects.

Definition at line 958 of file config.cc.

References ns3::Singleton< ConfigImpl >::Get(), ns3::Config::ConfigImpl::GetRootNamespaceObjectN(), and NS_LOG_FUNCTION_NOARGS.

Referenced by GetTypicalAggregations(), and ns3::AttributeIterator::Iterate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LookupMatches()

MatchContainer ns3::Config::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 940 of file config.cc.

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

Referenced by ns3::RandomVariableStreamHelper::AssignStreams(), ns3::LteStatsCalculator::FindCellIdFromEnbRlcPath(), ns3::LteStatsCalculator::FindImsiFromEnbRlcPath(), ns3::LteStatsCalculator::FindImsiFromLteNetDevice(), ns3::LteStatsCalculator::FindImsiFromUePhy(), ns3::RadioEnvironmentMapHelper::Install(), ns3::GnuplotHelper::PlotProbe(), and ns3::FileHelper::WriteProbe().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterRootNamespaceObject()

void ns3::Config::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 946 of file config.cc.

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

Referenced by ns3::BuildingListPriv::DoGet(), ns3::ChannelListPriv::DoGet(), ns3::NodeListPriv::DoGet(), ns3::tests::RootNamespaceConfigTestCase::DoRun(), ns3::tests::UnderRootNamespaceConfigTestCase::DoRun(), ns3::tests::ObjectVectorConfigTestCase::DoRun(), ns3::tests::ObjectVectorTraceConfigTestCase::DoRun(), and ns3::tests::SearchAttributesOfParentObjectsTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Reset()

void ns3::Config::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.

Definition at line 820 of file config.cc.

References ns3::GlobalValue::Begin(), ns3::GlobalValue::End(), ns3::TypeId::GetAttribute(), ns3::TypeId::GetAttributeN(), ns3::TypeId::GetRegistered(), ns3::TypeId::GetRegisteredN(), NS_LOG_FUNCTION_NOARGS, ns3::TypeId::AttributeInformation::originalInitialValue, and ns3::TypeId::SetAttributeInitialValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Set()

void ns3::Config::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 839 of file config.cc.

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

Referenced by ns3::TupleValue< Args >::TupleValue(), ns3::RawTextConfigLoad::Attributes(), ns3::XmlConfigLoad::Attributes(), IdealRateManagerChannelWidthTest::ChangeChannelWidth(), WifiChannelSwitchingTest::ChannelSwitch(), ns3::tests::RootNamespaceConfigTestCase::DoRun(), ns3::tests::UnderRootNamespaceConfigTestCase::DoRun(), ns3::tests::ObjectVectorConfigTestCase::DoRun(), ns3::tests::SearchAttributesOfParentObjectsTestCase::DoRun(), LteEpcE2eDataTestCase::DoRun(), Bug730TestCase::DoRun(), QosFragmentationTestCase::DoRun(), SetChannelFrequencyTest::DoRun(), NetAnimExperiment::IncrementCw(), Experiment::IncrementCw(), Experiment::Run(), TestInterBssConstantObssPdAlgo::RunOne(), IdealRateManagerMimoTest::SetApMimoSettings(), and IdealRateManagerMimoTest::SetStaMimoSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDefault()

void ns3::Config::SetDefault	(	std::string	name,
		const AttributeValue &	value
	)

Parameters

[in]	name	The full name of the attribute
[in]	value	The 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.

Definition at line 849 of file config.cc.

References NS_FATAL_ERROR, NS_LOG_FUNCTION, and ns3::Config::SetDefaultFailSafe().

Here is the call graph for this function:

◆ SetDefaultFailSafe()

bool ns3::Config::SetDefaultFailSafe	(	std::string	name,
		const AttributeValue &	value
	)

Parameters

[in]	name	The full name of the attribute
[in]	value	The value to set.

Returns: true if the value was set successfully, false otherwise.

This method overrides the initial value of the matching attribute.

Definition at line 857 of file config.cc.

References ns3::TypeId::AttributeInformation::checker, ns3::TypeId::GetAttribute(), ns3::TypeId::GetAttributeN(), ns3::TypeId::LookupAttributeByName(), ns3::TypeId::LookupByNameFailSafe(), ns3::TypeId::AttributeInformation::name, NS_LOG_FUNCTION, and ns3::TypeId::SetAttributeInitialValue().

Referenced by ns3::cell_edited_callback_config_default(), AttributeTestCase< T >::DoRun(), ns3::CommandLine::HandleArgument(), ns3::CommandLine::HandleAttribute(), and ns3::Config::SetDefault().

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
	)

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.