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

#include <object-base.h>

Inheritance diagram for ns3::ObjectBase:

Public Member Functions
virtual	~ObjectBase ()
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
virtual TypeId	GetInstanceTypeId (void) const =0
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Protected Member Functions
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

Private Member Functions
bool	DoSet (Ptr< const AttributeAccessor > spec, Ptr< const AttributeChecker > checker, const AttributeValue &value)

Detailed Description

implement the ns-3 type and attribute system

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.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::ObjectBase::~ObjectBase ( )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

protected

Parameters

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

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.

Definition at line 65 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_LOG_DEBUG, and NS_LOG_FUNCTION.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

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

References ns3::AttributeChecker::CreateValidValue(), and NS_LOG_FUNCTION.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters

name	the name of the attribute to read
value	a reference to the value where the result should be stored.

Returns: the attribute read.

If the input attribute name does not exist, this method crashes.

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

References ns3::TypeId::AttributeInformation::accessor, ns3::TypeId::ATTR_GET, ns3::TypeId::AttributeInformation::checker, ns3::AttributeChecker::Create(), ns3::TypeId::AttributeInformation::flags, ns3::AttributeAccessor::Get(), GetInstanceTypeId(), ns3::AttributeAccessor::HasGetter(), NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::PeekPointer(), ns3::AttributeValue::SerializeToString(), and ns3::StringValue::Set().

Referenced by ns3::DistributedSimulatorImpl::CalculateLookAhead(), ns3::cell_data_function_col_1(), ns3::cell_tooltip_callback(), ns3::LteRrcConnectionEstablishmentTestCase::CheckConnected(), ns3::LteX2HandoverTestCase::CheckConnected(), ns3::LenaMimoTestCase::DoRun(), RootNamespaceConfigTestCase::DoRun(), UnderRootNamespaceConfigTestCase::DoRun(), ObjectVectorConfigTestCase::DoRun(), ObjectVectorAttributeTestCase::DoRun(), ObjectMapAttributeTestCase::DoRun(), IntegerTraceSourceAttributeTestCase::DoRun(), PointerAttributeTestCase::DoRun(), ns3::UanPhyDual::GetModesPhy1(), ns3::UanPhyDual::GetModesPhy2(), ns3::RandomBuildingPositionAllocator::GetNext(), ns3::RandomRoomPositionAllocator::GetNext(), ns3::UanPhyDual::GetPerModelPhy1(), ns3::UanPhyDual::GetPerModelPhy2(), ns3::UanPhyDual::GetSinrModelPhy1(), ns3::UanPhyDual::GetSinrModelPhy2(), main(), ns3::Packet::Print(), and ns3::QosWifiMacHelper::Setup().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters

name	the name of the attribute to read
attribute	the attribute where the result value should be stored

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

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

References ns3::TypeId::AttributeInformation::accessor, ns3::TypeId::ATTR_GET, ns3::TypeId::AttributeInformation::checker, ns3::AttributeChecker::Create(), ns3::TypeId::AttributeInformation::flags, ns3::AttributeAccessor::Get(), GetInstanceTypeId(), ns3::AttributeAccessor::HasGetter(), NS_LOG_FUNCTION, ns3::PeekPointer(), ns3::AttributeValue::SerializeToString(), and ns3::StringValue::Set().

Referenced by AttributeTestCase< T >::CheckGetCodePaths().

Here is the call graph for this function:

Here is the caller graph for this function:

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

pure virtual

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

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

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

Here is the caller graph for this function:

TypeId ns3::ObjectBase::GetTypeId ( void )

static

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

References ns3::GetObjectIid(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ConstructSelf().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::ObjectBase::NotifyConstructionCompleted ( void )

protectedvirtual

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 59 of file object-base.cc.

References NS_LOG_FUNCTION.

Referenced by ConstructSelf().

Here is the caller graph for this function:

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

Parameters

name	the name of the attribute to set
value	the name of the attribute to set

Set a single attribute. This cannot fail: if the input is invalid, it will crash immediately.

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

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

Here is the call graph for this function:

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

Parameters

name	the name of the attribute to set
value	the name of the attribute to set

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

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

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

Referenced by DropTailQueueTestCase::DoRun(), WaypointLazyNotifyTrue::DoRun(), WaypointInitialPositionIsWaypoint::DoRun(), AttributeTestCase< T >::DoRun(), RandomVariableStreamAttributeTestCase::DoRun(), IntegerTraceSourceAttributeTestCase::DoRun(), IntegerTraceSourceTestCase::DoRun(), PointerAttributeTestCase::DoRun(), CallbackValueTestCase::DoRun(), ns3::LteHelper::InstallSingleEnbDevice(), and RedQueueTestCase::RunRedTest().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters

name	the name of the targetted trace source
context	the trace context associated to the callback
cb	the callback to connect to the trace source.

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

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

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

Referenced by ns3::AnimationInterface::ConnectLteEnb(), and ns3::AnimationInterface::ConnectLteUe().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters

name	the name of the targetted trace source
cb	the callback to connect to the trace source.

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

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

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

Referenced by ns3::Config::MatchContainer::ConnectWithoutContext(), ns3::LteRlcUmE2eTestCase::DoRun(), ns3::LteRlcAmE2eTestCase::DoRun(), SequenceNumberTestCase::DoRun(), Ns3TcpCwndTestCase1::DoRun(), ns3::Bug555TestCase::DoRun(), Ns3TcpCwndTestCase2::DoRun(), IntegerTraceSourceTestCase::DoRun(), TracedCallbackTestCase::DoRun(), ns3::InternetStackHelper::EnableAsciiIpv4Internal(), ns3::YansWifiPhyHelper::EnablePcapInternal(), ns3::WimaxHelper::EnablePcapInternal(), ns3::InternetStackHelper::EnablePcapIpv4Internal(), ns3::aodv::RoutingProtocol::NotifyInterfaceUp(), ns3::HierarchicalMobilityModel::SetChild(), ns3::dot11s::PeerManagementProtocolMac::SetParent(), and ns3::HierarchicalMobilityModel::SetParent().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters

name	the name of the targetted trace source
context	the trace context associated to the callback
cb	the callback to disconnect from the trace source.

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

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

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

Here is the call graph for this function:

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

Parameters

name	the name of the targetted trace source
cb	the callback to disconnect from the trace source.

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

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

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

Referenced by ns3::Config::MatchContainer::DisconnectWithoutContext(), ns3::dsr::DsrRouting::DoDispose(), IntegerTraceSourceTestCase::DoRun(), TracedCallbackTestCase::DoRun(), ns3::aodv::RoutingProtocol::NotifyInterfaceDown(), ns3::HierarchicalMobilityModel::SetChild(), and ns3::HierarchicalMobilityModel::SetParent().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation