Anchor the ns-3 type and attribute system. More...

#include "object-base.h"

Inheritance diagram for ns3::ObjectBase:

Public Member Functions
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

virtual TypeId	GetInstanceTypeId (void) const =0
	Get the most derived TypeId for this Object. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Member Functions
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Private Member Functions
bool	DoSet (Ptr< const AttributeAccessor > spec, Ptr< const AttributeChecker > checker, const AttributeValue &value)
	Attempt to set the value referenced by the accessor `spec` to a valid value according to the `checker`, based on `value`. More...

Related Functions
(Note that these are not member functions.)
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Anchor the ns-3 type and attribute system.

Introspection did not find any typical Config paths.

Every class which wants to integrate in the ns-3 type and attribute system should derive from this base class. This base class provides:

A way to associate an ns3::TypeId to each object instance.
A way to set and get the attributes registered in the ns3::TypeId.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 8 bytes (on a 64-bit architecture).

Definition at line 119 of file object-base.h.

Constructor & Destructor Documentation

◆ ~ObjectBase()

ns3::ObjectBase::~ObjectBase ( )

virtual

Virtual destructor.

Definition at line 68 of file object-base.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ConstructSelf()

void ns3::ObjectBase::ConstructSelf ( const AttributeConstructionList & attributes )

protected

Complete construction of ObjectBase; invoked by derived classes.

Invoked from subclasses to initialize all of their attribute members. This method will typically be invoked automatically from ns3::CreateObject if your class derives from ns3::Object. If you derive from ns3::ObjectBase directly, you should make sure that you invoke this method from your most-derived constructor.

Parameters

[in] attributes The attribute values used to initialize the member variables of this object's instance.

Definition at line 80 of file object-base.cc.

References ns3::TypeId::AttributeInformation::accessor, ns3::TypeId::ATTR_CONSTRUCT, ns3::TypeId::AttributeInformation::checker, DoSet(), ns3::AttributeConstructionList::Find(), ns3::TypeId::AttributeInformation::flags, ns3::TypeId::GetAttribute(), ns3::TypeId::GetAttributeFullName(), ns3::TypeId::GetAttributeN(), GetInstanceTypeId(), ns3::TypeId::GetName(), ns3::TypeId::GetParent(), GetTypeId(), ns3::TypeId::AttributeInformation::initialValue, ns3::TypeId::AttributeInformation::name, NotifyConstructionCompleted(), NS_FATAL_ERROR, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by ns3::ConfigStore::ConfigStore(), ns3::Object::Construct(), ns3::EmuEpcHelper::EmuEpcHelper(), ns3::PointToPointEpcHelper::PointToPointEpcHelper(), and ns3::RttEstimator::RttEstimator().

◆ DoSet()

bool ns3::ObjectBase::DoSet	(	Ptr< const AttributeAccessor >	spec,
		Ptr< const AttributeChecker >	checker,
		const AttributeValue &	value
	)

private

Attempt to set the value referenced by the accessor spec to a valid value according to the checker, based on value.

Parameters

[in]	spec	The accessor for the storage location.
[in]	checker	The checker to use in validating the value.
[in]	value	The value to attempt to store.

Returns: true if the value could be validated by the checker and written to the storage location.

Definition at line 170 of file object-base.cc.

References NS_LOG_FUNCTION.

Referenced by ConstructSelf(), SetAttribute(), and SetAttributeFailSafe().

◆ GetAttribute()

void ns3::ObjectBase::GetAttribute	(	std::string	name,
		AttributeValue &	value
	)		const

Get the value of an attribute, raising fatal errors if unsuccessful.

This will either succeed at setting the attribute or it will raise NS_FATAL_ERROR() on these conditions:

The attribute doesn't exist in this Object.
The attribute can't be read (no Getter).
The attribute doesn't support string formatting.
The attribute couldn't be serialized into the AttributeValue.

Parameters

[in]	name	The name of the attribute to read.
[out]	value	Where the result should be stored.

Definition at line 223 of file object-base.cc.

References ns3::TypeId::AttributeInformation::accessor, ns3::TypeId::ATTR_GET, ns3::TypeId::AttributeInformation::checker, ns3::TypeId::AttributeInformation::flags, GetInstanceTypeId(), NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::PeekPointer(), and ns3::StringValue::Set().

Referenced by AssignWifiRandomStreams(), TcpIllinoisTest::CalculateAlpha(), TcpIllinoisTest::CalculateBeta(), TcpYeahDecrementTest::CalculateSsThresh(), ns3::cell_data_function_col_1(), ns3::cell_tooltip_callback(), LteX2HandoverTestCase::CheckConnected(), LteRrcConnectionEstablishmentTestCase::CheckConnected(), LteX2HandoverMeasuresTestCase::CheckConnected(), WifiAcMappingTest::DoRun(), TcpHyblaIncrementTest::DoRun(), TcpScalableIncrementTest::DoRun(), TcpVenoTest::DoRun(), TcpScalableDecrementTest::DoRun(), ObjectVectorAttributeTestCase::DoRun(), ObjectMapAttributeTestCase::DoRun(), IntegerTraceSourceAttributeTestCase::DoRun(), PointerAttributeTestCase::DoRun(), TcpBicDecrementTest::ExecuteTest(), TcpLedbatDecrementTest::ExecuteTest(), TcpVegasTest::IncreaseWindow(), TcpYeahIncrementTest::IncreaseWindow(), ns3::Packet::Print(), TcpIllinoisTest::RecalcParam(), and TcpBicIncrementTest::Update().

◆ GetAttributeFailSafe()

bool ns3::ObjectBase::GetAttributeFailSafe	(	std::string	name,
		AttributeValue &	value
	)		const

Get the value of an attribute without raising erros.

If the attribute could not be read this will return false, but not raise any errors.

Parameters

[in]	name	The name of the attribute to read.
[out]	value	Where the result value should be stored.

Returns: true if the requested attribute was found, false otherwise.

Definition at line 258 of file object-base.cc.

References ns3::TypeId::AttributeInformation::accessor, ns3::TypeId::ATTR_GET, ns3::TypeId::AttributeInformation::checker, ns3::TypeId::AttributeInformation::flags, GetInstanceTypeId(), NS_LOG_FUNCTION, ns3::PeekPointer(), and ns3::StringValue::Set().

Referenced by AttributeTestCase< T >::CheckGetCodePaths(), TcFlowControlTestCase::CheckPacketsInDeviceQueue(), RttEstimatorTestCase::DoRun(), and PrioQueueDiscTestCase::DoRun().

◆ GetInstanceTypeId()

virtual TypeId ns3::ObjectBase::GetInstanceTypeId ( void ) const

pure virtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Referenced by ns3::PacketTagList::Add(), ns3::Packet::AddByteTag(), ns3::PacketMetadata::AddHeader(), ns3::Packet::AddHeader(), ns3::Packet::AddPacketTag(), ns3::PacketMetadata::AddTrailer(), ns3::Packet::AddTrailer(), ConstructSelf(), ns3::PacketTagList::COWTraverse(), ns3::Packet::FindFirstMatchingByteTag(), GetAttribute(), GetAttributeFailSafe(), ns3::ByteTagIterator::Item::GetTag(), ns3::PacketTagIterator::Item::GetTag(), ns3::PacketTagList::Peek(), ns3::Packet::PeekHeader(), ns3::Packet::PeekTrailer(), ns3::PacketMetadata::RemoveHeader(), ns3::Packet::RemoveHeader(), ns3::Packet::RemovePacketTag(), ns3::PacketMetadata::RemoveTrailer(), ns3::Packet::RemoveTrailer(), ns3::Packet::ReplacePacketTag(), ns3::PacketTagList::ReplaceWriter(), SetAttribute(), SetAttributeFailSafe(), TraceConnect(), TraceConnectWithoutContext(), TraceDisconnect(), and TraceDisconnectWithoutContext().

◆ GetTypeId()

TypeId ns3::ObjectBase::GetTypeId ( void )

static

Get the type ID.

Returns: The object TypeId.

Definition at line 61 of file object-base.cc.

References GetObjectIid(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ConstructSelf().

◆ NotifyConstructionCompleted()

void ns3::ObjectBase::NotifyConstructionCompleted ( void )

protectedvirtual

Notifier called once the ObjectBase is fully constructed.

This method is invoked once all member attributes have been initialized. Subclasses can override this method to be notified of this event but if they do this, they must chain up to their parent's NotifyConstructionCompleted method.

Reimplemented in ns3::FlowMonitor, and ns3::VisualSimulatorImpl.

Definition at line 74 of file object-base.cc.

References NS_LOG_FUNCTION.

Referenced by ConstructSelf(), and ns3::FlowMonitor::NotifyConstructionCompleted().

◆ SetAttribute()

void ns3::ObjectBase::SetAttribute	(	std::string	name,
		const AttributeValue &	value
	)

Set a single attribute, raising fatal errors if unsuccessful.

This will either succeed at setting the attribute or it will raise NS_FATAL_ERROR() on these conditions:

The attribute doesn't exist in this Object.
The attribute can't be set (no Setter).
The attribute couldn't be deserialized from the AttributeValue.

Parameters

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

Definition at line 185 of file object-base.cc.

References ns3::TypeId::AttributeInformation::accessor, ns3::TypeId::ATTR_SET, ns3::TypeId::AttributeInformation::checker, DoSet(), ns3::TypeId::AttributeInformation::flags, GetInstanceTypeId(), NS_FATAL_ERROR, and NS_LOG_FUNCTION.

◆ SetAttributeFailSafe()

bool ns3::ObjectBase::SetAttributeFailSafe	(	std::string	name,
		const AttributeValue &	value
	)

Set a single attribute without raising errors.

If the attribute could not be set this will return false, but not raise any errors.

Parameters

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

Returns: true if the requested attribute exists and could be set, false otherwise.

Definition at line 205 of file object-base.cc.

References ns3::TypeId::AttributeInformation::accessor, ns3::TypeId::ATTR_SET, ns3::TypeId::AttributeInformation::checker, DoSet(), ns3::TypeId::AttributeInformation::flags, GetInstanceTypeId(), and NS_LOG_FUNCTION.

Referenced by RttEstimatorTestCase::DoRun(), CoDelQueueDiscBasicEnqueueDequeue::DoRun(), WaypointLazyNotifyTrue::DoRun(), PrioQueueDiscTestCase::DoRun(), WaypointInitialPositionIsWaypoint::DoRun(), CoDelQueueDiscBasicOverflow::DoRun(), AttributeTestCase< T >::DoRun(), CoDelQueueDiscBasicDrop::DoRun(), RandomVariableStreamAttributeTestCase::DoRun(), IntegerTraceSourceAttributeTestCase::DoRun(), IntegerTraceSourceTestCase::DoRun(), PointerAttributeTestCase::DoRun(), CallbackValueTestCase::DoRun(), ns3::LteHelper::InstallSingleEnbDevice(), AredQueueDiscTestCase::RunAredDiscTest(), FifoQueueDiscTestCase::RunFifoTest(), PieQueueDiscTestCase::RunPieTest(), RedQueueDiscTestCase::RunRedTest(), and TbfQueueDiscTestCase::RunTbfTest().

◆ TraceConnect()

bool ns3::ObjectBase::TraceConnect	(	std::string	name,
		std::string	context,
		const CallbackBase &	cb
	)

Connect a TraceSource to a Callback with a context.

The target trace source should be registered with TypeId::AddTraceSource.

Parameters

[in]	name	The name of the target trace source.
[in]	context	The trace context associated to the callback.
[in]	cb	The callback to connect to the trace source.

Returns: true.

Definition at line 306 of file object-base.cc.

References GetInstanceTypeId(), ns3::TypeId::LookupTraceSourceByName(), and NS_LOG_FUNCTION.

Referenced by DhcpTestCase::DoRun(), ProbeTestCase1::DoRun(), and ns3::TcpGeneralTest::DoRun().

◆ TraceConnectWithoutContext()

bool ns3::ObjectBase::TraceConnectWithoutContext	(	std::string	name,
		const CallbackBase &	cb
	)

Connect a TraceSource to a Callback without a context.

The target trace source should be registered with TypeId::AddTraceSource.

Parameters

[in]	name	The name of the target trace source.
[in]	cb	The callback to connect to the trace source.

Returns: true.

Definition at line 293 of file object-base.cc.

References GetInstanceTypeId(), ns3::TypeId::LookupTraceSourceByName(), and NS_LOG_FUNCTION.

◆ TraceDisconnect()

bool ns3::ObjectBase::TraceDisconnect	(	std::string	name,
		std::string	context,
		const CallbackBase &	cb
	)

Disconnect from a TraceSource a Callback previously connected with a context.

The target trace source should be registered with TypeId::AddTraceSource.

Parameters

[in]	name	The name of the target trace source.
[in]	context	The trace context associated to the callback.
[in]	cb	The callback to disconnect from the trace source.

Returns: true.

Definition at line 332 of file object-base.cc.

References GetInstanceTypeId(), ns3::TypeId::LookupTraceSourceByName(), and NS_LOG_FUNCTION.

◆ TraceDisconnectWithoutContext()

bool ns3::ObjectBase::TraceDisconnectWithoutContext	(	std::string	name,
		const CallbackBase &	cb
	)

Disconnect from a TraceSource a Callback previously connected without a context.

The target trace source should be registered with TypeId::AddTraceSource.

Parameters

[in]	name	The name of the target trace source.
[in]	cb	The callback to disconnect from the trace source.

Returns: true.

Definition at line 319 of file object-base.cc.

References GetInstanceTypeId(), ns3::TypeId::LookupTraceSourceByName(), and NS_LOG_FUNCTION.

Referenced by ns3::Config::MatchContainer::DisconnectWithoutContext(), IntegerTraceSourceTestCase::DoRun(), TracedCallbackTestCase::DoRun(), ns3::HierarchicalMobilityModel::SetChild(), and ns3::HierarchicalMobilityModel::SetParent().

Friends And Related Function Documentation

◆ GetObjectIid()

static TypeId GetObjectIid ( void )

Returns: The TypeId for ObjectBase.

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

References NS_LOG_FUNCTION_NOARGS, ns3::TypeId::SetGroupName(), and ns3::TypeId::SetParent().

Referenced by GetTypeId().

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ObjectBase()

Member Function Documentation

◆ ConstructSelf()

◆ DoSet()

◆ GetAttribute()

◆ GetAttributeFailSafe()

◆ GetInstanceTypeId()

◆ GetTypeId()

◆ NotifyConstructionCompleted()

◆ SetAttribute()

◆ SetAttributeFailSafe()

◆ TraceConnect()

◆ TraceConnectWithoutContext()

◆ TraceDisconnect()

◆ TraceDisconnectWithoutContext()

Friends And Related Function Documentation

◆ GetObjectIid()