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

#include "object-factory.h"

Collaboration diagram for ns3::ObjectFactory:

Public Member Functions
	ObjectFactory ()
	Default constructor. More...

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

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

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

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

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

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

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


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

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

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

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

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

TypeId	m_tid
	The TypeId this factory will create. More...

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

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

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: ObjectFactory Attribute

Definition at line 47 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 34 of file object-factory.cc.

References NS_LOG_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 215 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 ( void ) const

Create an Object instance of the configured TypeId.

Returns: A new object instance.

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

References ns3::Object::Construct(), ns3::TypeId::GetConstructor(), m_parameters, m_tid, NS_ASSERT, NS_LOG_FUNCTION, and ns3::Object::SetTypeId().

Here is the call graph for this function:

◆ Create() [2/2]

template<typename T >

Ptr< T > ns3::ObjectFactory::Create ( void ) 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 208 of file object-factory.h.

References Create().

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 67 of file object-factory.cc.

References ns3::AttributeConstructionList::Add(), ns3::TypeId::AttributeInformation::checker, ns3::TypeId::GetName(), ns3::TypeId::LookupAttributeByName(), m_parameters, m_tid, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by Set().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ObjectFactory::GetTypeId ( void ) const

Get the TypeId which will be created by this ObjectFactory.

Returns: The currently-selected TypeId.

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

References m_tid, and NS_LOG_FUNCTION.

Referenced by ns3::WifiRadioEnergyModelHelper::DoInstall(), ns3::LteHelper::GetEnbComponentCarrierManagerType(), ns3::LteHelper::GetFfrAlgorithmType(), ns3::LteHelper::GetHandoverAlgorithmType(), ns3::MobilityHelper::GetMobilityModelType(), ns3::LteHelper::GetSchedulerType(), ns3::LteHelper::GetUeComponentCarrierManagerType(), ns3::TrafficControlHelper::Install(), and ns3::MobilityHelper::Install().

Here is the caller graph for this function:

◆ IsTypeIdSet()

bool ns3::ObjectFactory::IsTypeIdSet ( void ) 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 58 of file object-factory.cc.

References ns3::TypeId::GetUid(), and m_tid.

Referenced by ns3::SpectrumWifiPhyHelper::Create(), ns3::YansWifiPhyHelper::Create(), ns3::WifiMacHelper::Create(), ns3::WifiHelper::Install(), and ns3::GroupMobilityHelper::Install().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Set() [1/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 223 of file object-factory.h.

References DoSet(), and Set().

Here is the call graph for this function:

◆ Set() [2/2]

void ns3::ObjectFactory::Set ( void )

inline

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

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

Referenced by ObjectFactory(), and Set().

Here is the caller graph for this function:

◆ SetTypeId() [1/3]

void ns3::ObjectFactory::SetTypeId ( const char * 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 52 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/3]

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 46 of file object-factory.cc.

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

Here is the call graph for this function:

◆ SetTypeId() [3/3]

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 40 of file object-factory.cc.

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

Referenced by ns3::AcousticModemEnergyModelHelper::AcousticModemEnergyModelHelper(), ns3::AdhocAlohaNoackIdealPhyHelper::AdhocAlohaNoackIdealPhyHelper(), ns3::AodvHelper::AodvHelper(), ns3::BasicEnergyHarvesterHelper::BasicEnergyHarvesterHelper(), ns3::BasicEnergySourceHelper::BasicEnergySourceHelper(), ns3::BridgeHelper::BridgeHelper(), ns3::BulkSendHelper::BulkSendHelper(), ns3::CcHelper::CcHelper(), ns3::CsmaHelper::CsmaHelper(), ns3::DhcpHelper::DhcpHelper(), ns3::DsdvHelper::DsdvHelper(), ns3::DsrHelper::DsrHelper(), ns3::FdNetDeviceHelper::FdNetDeviceHelper(), ns3::FlowMonitorHelper::FlowMonitorHelper(), anonymous_namespace{test-string-value-formatting.cc}::FormattingTestObjectHelper::FormattingTestObjectHelper(), ns3::GridBuildingAllocator::GridBuildingAllocator(), ns3::LiIonEnergySourceHelper::LiIonEnergySourceHelper(), ns3::LteHelper::LteHelper(), ns3::LteSimpleHelper::LteSimpleHelper(), ns3::MobilityHelper::MobilityHelper(), ObjectFactory(), ns3::OlsrHelper::OlsrHelper(), ns3::OnOffHelper::OnOffHelper(), ns3::PacketSinkHelper::PacketSinkHelper(), ns3::Ping6Helper::Ping6Helper(), ns3::PointToPointHelper::PointToPointHelper(), ns3::QKDAppHelper::QKDAppHelper(), ns3::QKDLinkHelper::QKDLinkHelper(), ns3::RadvdHelper::RadvdHelper(), ns3::RipHelper::RipHelper(), ns3::RipNgHelper::RipNgHelper(), ns3::RvBatteryModelHelper::RvBatteryModelHelper(), ns3::SimpleNetDeviceHelper::SimpleNetDeviceHelper(), SimulatorTestSuite::SimulatorTestSuite(), ns3::SixLowPanHelper::SixLowPanHelper(), ns3::SpectrumAnalyzerHelper::SpectrumAnalyzerHelper(), ns3::SpectrumWifiPhyHelper::SpectrumWifiPhyHelper(), ns3::TapBridgeHelper::TapBridgeHelper(), ThreadedSimulatorTestSuite::ThreadedSimulatorTestSuite(), ns3::ThreeGppHttpClientHelper::ThreeGppHttpClientHelper(), ns3::ThreeGppHttpServerHelper::ThreeGppHttpServerHelper(), ns3::TvSpectrumTransmitterHelper::TvSpectrumTransmitterHelper(), ns3::UanHelper::UanHelper(), ns3::UdpClientHelper::UdpClientHelper(), ns3::UdpEchoClientHelper::UdpEchoClientHelper(), ns3::UdpEchoServerHelper::UdpEchoServerHelper(), ns3::UdpServerHelper::UdpServerHelper(), ns3::UdpTraceClientHelper::UdpTraceClientHelper(), ns3::V4PingHelper::V4PingHelper(), ns3::V4TraceRouteHelper::V4TraceRouteHelper(), ns3::WaveBsmHelper::WaveBsmHelper(), ns3::WaveformGeneratorHelper::WaveformGeneratorHelper(), ns3::WifiMacHelper::WifiMacHelper(), ns3::WifiRadioEnergyModelHelper::WifiRadioEnergyModelHelper(), ns3::YansWifiPhyHelper::YansWifiPhyHelper(), ns3::FileHelper::AddProbe(), ns3::GnuplotHelper::AddProbe(), ns3::SpectrumChannelHelper::AddPropagationLoss(), ns3::YansWifiChannelHelper::AddPropagationLoss(), ns3::SpectrumChannelHelper::AddSpectrumPropagationLoss(), ns3::LteUeRrc::ApplyRadioResourceConfigDedicated(), BuildSimpleTopology(), ns3::PfifoFastQueueDisc::CheckConfig(), ns3::PrioQueueDisc::CheckConfig(), ns3::TbfQueueDisc::CheckConfig(), ns3::InternetStackHelper::CreateAndAggregateObjectFromTypeId(), ns3::QKDLinkHelper::CreateAndAggregateObjectFromTypeId(), ns3::CreateObjectWithAttributes(), ns3::TcpOption::CreateOption(), ns3::TcpGeneralTest::CreateSocket(), ns3::TcpL4Protocol::CreateSocket(), ns3::WifiPhyHelper::DisablePreambleDetectionModel(), UanTest::DoPhyTests(), ThreeGppV2vBuildingsChCondModelTestCase::DoRun(), ThreeGppV2vUrbanLosNlosvChCondModelTestCase::DoRun(), ThreeGppV2vHighwayLosNlosvChCondModelTestCase::DoRun(), PointerAttributeTestCase::DoRun(), ns3::tests::ObjectFactoryTestCase::DoRun(), BasicEnergyHarvesterTestCase::DoRun(), SteadyStateRandomWaypointTest::DoRun(), WaypointMobilityModelNotifyTest::DoRun(), WaypointMobilityModelAddWaypointTest::DoRun(), ThreeGppChannelConditionModelTestCase::DoRun(), V2vUrbanProbChCondModelTestCase::DoRun(), V2vHighwayProbChCondModelTestCase::DoRun(), AmpduAggregationTest::DoRun(), TwoLevelAggregationTest::DoRun(), WifiTest::DoRun(), InterferenceHelperSequenceTest::DoRun(), DcfImmediateAccessBroadcastTestCase::DoRun(), Bug2831TestCase::DoRun(), HeAggregationTest::DoRunSubTest(), ns3::anonymous_namespace{visual-simulator-impl.cc}::GetDefaultSimulatorImplFactory(), ns3::GetImpl(), ns3::FqCobaltQueueDisc::InitializeParams(), ns3::FqCoDelQueueDisc::InitializeParams(), ns3::FqPieQueueDisc::InitializeParams(), ns3::EnergyHarvesterHelper::Install(), ns3::EnergySourceHelper::Install(), ns3::PointToPointHelper::Install(), ns3::QKDLinkHelper::InstallQKDControl(), ns3::QKDLinkHelper::InstallQKDEncryptor(), RoutingExperiment::Run(), FifoQueueDiscTestCase::RunFifoTest(), ns3::WifiMacHelper::SetAckManager(), ns3::AdhocAlohaNoackIdealPhyHelper::SetAntenna(), ns3::SpectrumAnalyzerHelper::SetAntenna(), ns3::WaveformGeneratorHelper::SetAntenna(), ns3::SpectrumChannelHelper::SetChannel(), ns3::SimpleNetDeviceHelper::SetChannel(), ns3::WaveHelper::SetChannelScheduler(), ns3::LteHelper::SetEnbAntennaModelType(), ns3::LteHelper::SetEnbComponentCarrierManagerType(), ns3::WifiPhyHelper::SetErrorRateModel(), ns3::LteHelper::SetFadingModel(), ns3::LteHelper::SetFfrAlgorithmType(), ns3::WifiPhyHelper::SetFrameCaptureModel(), ns3::LteHelper::SetHandoverAlgorithmType(), ns3::Simulator::SetImplementation(), ns3::WifiPhyHelper::SetInterferenceHelper(), ns3::UanHelper::SetMac(), ns3::MeshHelper::SetMacType(), ns3::GroupMobilityHelper::SetMemberMobilityModel(), ns3::GroupMobilityHelper::SetMemberPositionAllocator(), ns3::MobilityHelper::SetMobilityModel(), ns3::WifiMacHelper::SetMultiUserScheduler(), ns3::WifiHelper::SetObssPdAlgorithm(), ns3::LteHelper::SetPathlossModelType(), ns3::SpectrumPhyHelper::SetPhy(), ns3::UanHelper::SetPhy(), ns3::MobilityHelper::SetPositionAllocator(), ns3::WifiPhyHelper::SetPreambleDetectionModel(), ns3::SpectrumChannelHelper::SetPropagationDelay(), ns3::YansWifiChannelHelper::SetPropagationDelay(), ns3::WifiMacHelper::SetProtectionManager(), ns3::CsmaHelper::SetQueue(), ns3::SimpleNetDeviceHelper::SetQueue(), ns3::PointToPointHelper::SetQueue(), ns3::TrafficControlHelper::SetQueueLimits(), ns3::GroupMobilityHelper::SetReferenceMobilityModel(), ns3::GroupMobilityHelper::SetReferencePositionAllocator(), ns3::WifiHelper::SetRemoteStationManager(), ns3::MeshHelper::SetRemoteStationManager(), ns3::WaveHelper::SetRemoteStationManager(), ns3::LteHelper::SetSchedulerType(), ns3::QKDAppHelper::SetSettings(), ns3::LteHelper::SetSpectrumChannelType(), ns3::MeshHelper::SetStackInstaller(), ns3::InternetStackHelper::SetTcp(), ns3::UanHelper::SetTransducer(), ns3::WifiRadioEnergyModelHelper::SetTxCurrentModel(), ns3::NetDeviceQueueInterface::SetTxQueuesType(), ns3::WifiMacHelper::SetType(), ns3::FdNetDeviceHelper::SetTypeId(), ns3::LteHelper::SetUeAntennaModelType(), ns3::LteHelper::SetUeComponentCarrierManagerType(), VanetRoutingExperiment::SetupAdhocMobilityNodes(), ns3::UeManager::SetupDataRadioBearer(), DsdvManetExample::SetupMobility(), PowerRateAdaptationTest::TestAparf(), PowerRateAdaptationTest::TestParf(), and PowerRateAdaptationTest::TestRrpaa().

Here is the call graph for this function:

Friends And Related Function 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 111 of file object-factory.cc.

◆ 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 126 of file object-factory.cc.

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 171 of file object-factory.h.

Referenced by Create(), and DoSet().

◆ m_tid

TypeId ns3::ObjectFactory::m_tid

private

The TypeId this factory will create.

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

Referenced by Create(), DoSet(), GetTypeId(), IsTypeIdSet(), 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/3]

◆ SetTypeId() [2/3]

◆ SetTypeId() [3/3]

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ m_parameters

◆ m_tid