Instantiate subclasses of ns3::Object. More...

#include "object-factory.h"

Collaboration diagram for ns3::ObjectFactory:

Public Member Functions
	ObjectFactory ()
	Default constructor.

template<typename... Args>
	ObjectFactory (const std::string &typeId, Args &&... args)
	Construct a factory for a specific TypeId by name.

Ptr< Object >	Create () const
	Create an Object instance of the configured TypeId.

template<typename T>
Ptr< T >	Create () const
	Create an Object instance of the requested type.

TypeId	GetTypeId () const
	Get the TypeId which will be created by this ObjectFactory.

bool	IsTypeIdSet () const
	Check if the ObjectFactory has been configured with a TypeId.

void	Set ()
	Base case to stop the recursion performed by the templated version of this method.

template<typename... Args>
void	Set (const std::string &name, const AttributeValue &value, Args &&... args)
	Set an attribute to be set during construction.


void	SetTypeId (TypeId tid)
	Set the TypeId of the Objects to be created by this factory.

void	SetTypeId (std::string tid)
	Set the TypeId of the Objects to be created by this factory.

Private Member Functions
void	DoSet (const std::string &name, const AttributeValue &value)
	Set an attribute to be set during construction.

Private Attributes
AttributeConstructionList	m_parameters
	The list of attributes and values to be used in constructing objects by this factory.

TypeId	m_tid
	The TypeId this factory will create.

Friends
std::ostream &	operator<< (std::ostream &os, const ObjectFactory &factory)
	Print the factory configuration on an output stream.

std::istream &	operator>> (std::istream &is, ObjectFactory &factory)
	Read a factory configuration from an input stream.

Detailed Description

Instantiate subclasses of ns3::Object.

This class can also hold a set of attributes to set automatically during the object construction.

See also: attribute_ObjectFactory

Definition at line 36 of file object-factory.h.

Constructor & Destructor Documentation

◆ ObjectFactory() [1/2]

ns3::ObjectFactory::ObjectFactory ( )

Default constructor.

This factory is not capable of constructing a real Object until it has at least a TypeId.

Definition at line 25 of file object-factory.cc.

References NS_LOG_FUNCTION.

Referenced by operator<<, and operator>>.

Here is the caller graph for this function:

◆ ObjectFactory() [2/2]

template<typename... Args>

ns3::ObjectFactory::ObjectFactory	(	const std::string &	typeId,
		Args &&...	args )

Construct a factory for a specific TypeId by name.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs

Parameters

[in]	typeId	The name of the TypeId this factory should create.
[in]	args	A sequence of name-value pairs of additional attributes to set.

The args sequence can be made of any number of pairs, each consisting of a name (of std::string type) followed by a value (of const AttributeValue & type).

Definition at line 205 of file object-factory.h.

References Set(), and SetTypeId().

Here is the call graph for this function:

Member Function Documentation

◆ Create() [1/2]

Ptr< Object > ns3::ObjectFactory::Create ( ) const

Create an Object instance of the configured TypeId.

Returns: A new object instance.

Definition at line 82 of file object-factory.cc.

References m_parameters, m_tid, NS_ASSERT, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ns3::SpectrumChannelHelper::AddPropagationLoss(), ns3::SpectrumChannelHelper::AddSpectrumPropagationLoss(), ns3::LteUeRrc::ApplyRadioResourceConfigDedicated(), BuildSimpleTopology(), ns3::PfifoFastQueueDisc::CheckConfig(), ns3::PrioQueueDisc::CheckConfig(), ns3::TbfQueueDisc::CheckConfig(), Create(), ns3::WifiMacHelper::Create(), ns3::ClickInternetStackHelper::CreateAndAggregateObjectFromTypeId(), ns3::InternetStackHelper::CreateAndAggregateObjectFromTypeId(), ns3::MeshHelper::CreateInterface(), ns3::CreateObjectWithAttributes(), ns3::TcpOption::CreateOption(), ns3::TcpGeneralTest::CreateSocket(), ns3::TcpL4Protocol::CreateSocket(), ns3::PointerValue::DeserializeFromString(), Bug2831TestCase::DoRun(), BuildingsPenetrationLossesTestCase::DoRun(), ns3::tests::ObjectFactoryTestCase::DoRun(), PointerAttributeTestCase::DoRun(), SteadyStateRandomWaypointTest::DoRun(), ThreeGppChannelConditionModelTestCase::DoRun(), ThreeGppV2vBuildingsChCondModelTestCase::DoRun(), ThreeGppV2vHighwayLosNlosvChCondModelTestCase::DoRun(), ThreeGppV2vUrbanLosNlosvChCondModelTestCase::DoRun(), V2vHighwayProbChCondModelTestCase::DoRun(), V2vUrbanProbChCondModelTestCase::DoRun(), WaypointMobilityModelAddWaypointTest::DoRun(), WaypointMobilityModelNotifyTest::DoRun(), AmpduAggregationTest::DoSetup(), ns3::GetImpl(), ns3::EnergyHarvesterHelper::Install(), ns3::EnergySourceHelper::Install(), RoutingExperiment::Run(), FifoQueueDiscTestCase::RunFifoTest(), ThreeGppShadowingTestCase::RunTest(), ns3::GroupMobilityHelper::SetMemberPositionAllocator(), ns3::MobilityHelper::SetPositionAllocator(), ns3::GroupMobilityHelper::SetReferenceMobilityModel(), ns3::GroupMobilityHelper::SetReferencePositionAllocator(), ns3::DefaultSimulatorImpl::SetScheduler(), ns3::DistributedSimulatorImpl::SetScheduler(), ns3::NullMessageSimulatorImpl::SetScheduler(), ns3::RealtimeSimulatorImpl::SetScheduler(), ns3::UeManager::SetupDataRadioBearer(), and DsdvManetExample::SetupMobility().

Here is the caller graph for this function:

◆ Create() [2/2]

template<typename T>

Ptr< T > ns3::ObjectFactory::Create ( ) const

Create an Object instance of the requested type.

This method performs an extra call to ns3::Object::GetObject before returning a pointer of the requested type to the user. This method is really syntactical sugar.

Template Parameters

T	[explicit] The requested Object type.

Returns: A new object instance.

Definition at line 194 of file object-factory.h.

References Create(), and NS_ASSERT_MSG.

Here is the call graph for this function:

◆ DoSet()

void ns3::ObjectFactory::DoSet	(	const std::string &	name,
		const AttributeValue &	value )

private

Set an attribute to be set during construction.

Parameters

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

Definition at line 51 of file object-factory.cc.

References ns3::TypeId::AttributeInformation::checker, m_parameters, m_tid, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by Set().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ObjectFactory::GetTypeId ( ) const

Get the TypeId which will be created by this ObjectFactory.

Returns: The currently-selected TypeId.

Definition at line 75 of file object-factory.cc.

References m_tid, and NS_LOG_FUNCTION.

Referenced by BenchSuite::BenchSuite().

Here is the caller graph for this function:

◆ IsTypeIdSet()

bool ns3::ObjectFactory::IsTypeIdSet ( ) const

Check if the ObjectFactory has been configured with a TypeId.

Returns: true if a TypeId has been configured to the ObjectFactory

Definition at line 45 of file object-factory.cc.

References m_tid.

◆ Set() [1/2]

void ns3::ObjectFactory::Set ( )

inline

Base case to stop the recursion performed by the templated version of this method.

Definition at line 94 of file object-factory.h.

Referenced by ObjectFactory(), and Set().

Here is the caller graph for this function:

◆ Set() [2/2]

template<typename... Args>

void ns3::ObjectFactory::Set	(	const std::string &	name,
		const AttributeValue &	value,
		Args &&...	args )

Set an attribute to be set during construction.

Template Parameters

Args	[deduced] Template type parameter pack for the sequence of name-value pairs

Parameters

[in]	name	The name of the attribute to set.
[in]	value	The value of the attribute to set.
[in]	args	A sequence of name-value pairs of additional attributes to set.

The args sequence can be made of any number of pairs, each consisting of a name (of std::string type) followed by a value (of const AttributeValue & type).

Definition at line 213 of file object-factory.h.

References DoSet(), and Set().

Referenced by BuildSimpleTopology(), ns3::PfifoFastQueueDisc::CheckConfig(), ns3::WifiMacHelper::Create(), ns3::MeshHelper::CreateInterface(), ns3::CreateObjectWithAttributes(), PointerAttributeTestCase::DoRun(), SteadyStateRandomWaypointTest::DoRun(), WaypointMobilityModelAddWaypointTest::DoRun(), WaypointMobilityModelNotifyTest::DoRun(), RoutingExperiment::Run(), FifoQueueDiscTestCase::RunFifoTest(), ns3::lorawan::LoraRadioEnergyModelHelper::SetTxCurrentModel(), and DsdvManetExample::SetupMobility().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTypeId() [1/2]

void ns3::ObjectFactory::SetTypeId ( std::string tid )

Set the TypeId of the Objects to be created by this factory.

Parameters

[in] tid The TypeId of the object to instantiate.

Definition at line 38 of file object-factory.cc.

References ns3::TypeId::LookupByName(), m_tid, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetTypeId() [2/2]

void ns3::ObjectFactory::SetTypeId ( TypeId tid )

Set the TypeId of the Objects to be created by this factory.

Parameters

[in] tid The TypeId of the object to instantiate.

Definition at line 31 of file object-factory.cc.

References ns3::TypeId::GetName(), m_tid, and NS_LOG_FUNCTION.

Referenced by ObjectFactory(), SimulatorTestSuite::SimulatorTestSuite(), ThreadedSimulatorTestSuite::ThreadedSimulatorTestSuite(), ns3::LteUeRrc::ApplyRadioResourceConfigDedicated(), BuildSimpleTopology(), ns3::PfifoFastQueueDisc::CheckConfig(), ns3::PrioQueueDisc::CheckConfig(), ns3::TbfQueueDisc::CheckConfig(), ns3::ClickInternetStackHelper::CreateAndAggregateObjectFromTypeId(), ns3::InternetStackHelper::CreateAndAggregateObjectFromTypeId(), ns3::MeshHelper::CreateInterface(), ns3::CreateObjectWithAttributes(), ns3::TcpOption::CreateOption(), ns3::TcpGeneralTest::CreateSocket(), ns3::TcpL4Protocol::CreateSocket(), Bug2831TestCase::DoRun(), BuildingsPenetrationLossesTestCase::DoRun(), ns3::tests::ObjectFactoryTestCase::DoRun(), PointerAttributeTestCase::DoRun(), SteadyStateRandomWaypointTest::DoRun(), ThreeGppChannelConditionModelTestCase::DoRun(), ThreeGppV2vBuildingsChCondModelTestCase::DoRun(), ThreeGppV2vHighwayLosNlosvChCondModelTestCase::DoRun(), ThreeGppV2vUrbanLosNlosvChCondModelTestCase::DoRun(), V2vHighwayProbChCondModelTestCase::DoRun(), V2vUrbanProbChCondModelTestCase::DoRun(), WaypointMobilityModelAddWaypointTest::DoRun(), WaypointMobilityModelNotifyTest::DoRun(), AmpduAggregationTest::DoSetup(), ns3::anonymous_namespace{visual-simulator-impl.cc}::GetDefaultSimulatorImplFactory(), ns3::GetImpl(), ns3::EnergyHarvesterHelper::Install(), ns3::EnergySourceHelper::Install(), operator>>, RoutingExperiment::Run(), FifoQueueDiscTestCase::RunFifoTest(), ns3::Simulator::SetImplementation(), ns3::lorawan::LoraRadioEnergyModelHelper::SetTxCurrentModel(), ns3::UeManager::SetupDataRadioBearer(), and DsdvManetExample::SetupMobility().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const ObjectFactory &	factory )

friend

Print the factory configuration on an output stream.

The configuration will be printed as a string with the form "<TypeId-name>[<attribute-name>=<attribute-value>|...]"

Parameters

[in,out]	os	The stream.
[in]	factory	The ObjectFactory.

Returns: The stream.

Definition at line 98 of file object-factory.cc.

References ObjectFactory(), ns3::AttributeConstructionList::Begin(), ns3::AttributeConstructionList::End(), ns3::TypeId::GetName(), m_parameters, and m_tid.

◆ operator>>

std::istream & operator>>	(	std::istream &	is,
		ObjectFactory &	factory )

friend

Read a factory configuration from an input stream.

The configuration should be in the form "<TypeId-name>[<attribute-name>=<attribute-value>|...]"

Parameters

[in,out]	is	The input stream.
[out]	factory	The factory to configure as described by the stream.

Returns: The stream.

Definition at line 116 of file object-factory.cc.

References ObjectFactory(), ns3::AttributeConstructionList::Add(), ns3::TypeId::AttributeInformation::checker, ns3::TypeId::LookupAttributeByName(), m_parameters, m_tid, NS_ABORT_MSG_IF, NS_ASSERT, and SetTypeId().

Member Data Documentation

◆ m_parameters

AttributeConstructionList ns3::ObjectFactory::m_parameters

private

The list of attributes and values to be used in constructing objects by this factory.

Definition at line 160 of file object-factory.h.

Referenced by Create(), DoSet(), operator<<, and operator>>.

◆ m_tid

TypeId ns3::ObjectFactory::m_tid

private

The TypeId this factory will create.

Definition at line 155 of file object-factory.h.

Referenced by Create(), DoSet(), GetTypeId(), IsTypeIdSet(), operator<<, operator>>, SetTypeId(), and SetTypeId().

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

src/core/model/object-factory.h
src/core/model/object-factory.cc

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ObjectFactory() [1/2]

◆ ObjectFactory() [2/2]

Member Function Documentation

◆ Create() [1/2]

◆ Create() [2/2]

◆ DoSet()

◆ GetTypeId()

◆ IsTypeIdSet()

◆ Set() [1/2]

◆ Set() [2/2]

◆ SetTypeId() [1/2]

◆ SetTypeId() [2/2]

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ m_parameters

◆ m_tid