a unique identifier for an interface. More...

#include <type-id.h>

Classes
struct	AttributeInformation

struct	TraceSourceInformation

Public Types
enum	AttributeFlag { ATTR_GET = 1<<0, ATTR_SET = 1<<1, ATTR_CONSTRUCT = 1<<2, ATTR_SGC = ATTR_GET \| ATTR_SET \| ATTR_CONSTRUCT }
	Flags describing when a given attribute can be read or written. More...

typedef uint32_t	hash_t
	Type of hash values. More...

Public Member Functions
	TypeId (const char *name)

	TypeId ()

	TypeId (const TypeId &o)

	~TypeId ()

TypeId	AddAttribute (std::string name, std::string help, const AttributeValue &initialValue, Ptr< const AttributeAccessor > accessor, Ptr< const AttributeChecker > checker)

TypeId	AddAttribute (std::string name, std::string help, uint32_t flags, const AttributeValue &initialValue, Ptr< const AttributeAccessor > accessor, Ptr< const AttributeChecker > checker)

template<typename T >
TypeId	AddConstructor (void)

TypeId	AddTraceSource (std::string name, std::string help, Ptr< const TraceSourceAccessor > accessor)

struct TypeId::AttributeInformation	GetAttribute (uint32_t i) const

std::string	GetAttributeFullName (uint32_t i) const

uint32_t	GetAttributeN (void) const

Callback< ObjectBase * >	GetConstructor (void) const

std::string	GetGroupName (void) const

hash_t	GetHash (void) const

std::string	GetName (void) const

TypeId	GetParent (void) const

struct TypeId::TraceSourceInformation	GetTraceSource (uint32_t i) const

uint32_t	GetTraceSourceN (void) const

uint16_t	GetUid (void) const

bool	HasConstructor (void) const

bool	HasParent (void) const

TypeId	HideFromDocumentation (void)

bool	IsChildOf (TypeId other) const

bool	LookupAttributeByName (std::string name, struct AttributeInformation *info) const

Ptr< const TraceSourceAccessor >	LookupTraceSourceByName (std::string name) const

bool	MustHideFromDocumentation (void) const

TypeId &	operator= (const TypeId &o)

bool	SetAttributeInitialValue (uint32_t i, Ptr< const AttributeValue > initialValue)

TypeId	SetGroupName (std::string groupName)

TypeId	SetParent (TypeId tid)

template<typename T >
TypeId	SetParent (void)

void	SetUid (uint16_t tid)

Static Public Member Functions
static TypeId	GetRegistered (uint32_t i)

static uint32_t	GetRegisteredN (void)

static TypeId	LookupByHash (hash_t hash)

static bool	LookupByHashFailSafe (hash_t hash, TypeId *tid)

static TypeId	LookupByName (std::string name)

static bool	LookupByNameFailSafe (std::string name, TypeId *tid)

Private Member Functions
	TypeId (uint16_t tid)

void	DoAddConstructor (Callback< ObjectBase * > callback)

Private Attributes
uint16_t	m_tid

Friends
class	AttributeList

bool	operator!= (TypeId a, TypeId b)

bool	operator< (TypeId a, TypeId b)

bool	operator== (TypeId a, TypeId b)

Detailed Description

a unique identifier for an interface.

This class records a lot of meta-information about a subclass of the Object base class:

the base class of the subclass
the set of accessible constructors in the subclass
the set of 'attributes' accessible in the subclass

Internal:: See the discussion in IidManager about hash chaining of TypeId's.

Definition at line 49 of file type-id.h.

Member Typedef Documentation

typedef uint32_t ns3::TypeId::hash_t

Type of hash values.

Definition at line 79 of file type-id.h.

Member Enumeration Documentation

enum ns3::TypeId::AttributeFlag

Flags describing when a given attribute can be read or written.

Enumerator
ATTR_GET	The attribute can be read.
ATTR_SET	The attribute can be written.
ATTR_CONSTRUCT	The attribute can be written at construction-time.
ATTR_SGC	The attribute can be read, and written at any time.

Definition at line 55 of file type-id.h.

Constructor & Destructor Documentation

ns3::TypeId::TypeId ( const char * name )

explicit

Parameters

name	the name of the interface to construct.

No two instances can share the same name. The name is expected to be the full c++ typename of associated c++ object.

Definition at line 521 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

ns3::TypeId::TypeId ( )

inline

Definition at line 380 of file type-id.h.

Referenced by GetParent(), GetRegistered(), LookupByHash(), LookupByHashFailSafe(), LookupByName(), and LookupByNameFailSafe().

Here is the caller graph for this function:

ns3::TypeId::TypeId ( const TypeId & o )

inline

Definition at line 383 of file type-id.h.

ns3::TypeId::~TypeId ( )

inline

Definition at line 391 of file type-id.h.

ns3::TypeId::TypeId ( uint16_t tid )

explicitprivate

Definition at line 530 of file type-id.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

TypeId ns3::TypeId::AddAttribute	(	std::string	name,
		std::string	help,
		const AttributeValue &	initialValue,
		Ptr< const AttributeAccessor >	accessor,
		Ptr< const AttributeChecker >	checker
	)

Parameters

name	the name of the new attribute
help	some help text which describes the purpose of this attribute.
initialValue	the initial value for this attribute.
accessor	an instance of the associated AttributeAccessor subclass.
checker	an instance of the associated AttributeChecker subclass.

Returns: this TypeId instance

Record in this TypeId the fact that a new attribute exists.

Definition at line 688 of file type-id.cc.

References ATTR_SGC, ns3::AttributeValue::Copy(), ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by ns3::Ns3NscStack::GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::TypeId::AddAttribute	(	std::string	name,
		std::string	help,
		uint32_t	flags,
		const AttributeValue &	initialValue,
		Ptr< const AttributeAccessor >	accessor,
		Ptr< const AttributeChecker >	checker
	)

Parameters

name	the name of the new attribute
help	some help text which describes the purpose of this attribute
flags	flags which describe how this attribute can be read and/or written.
initialValue	the initial value for this attribute.
accessor	an instance of the associated AttributeAccessor subclass.
checker	an instance of the associated AttributeChecker subclass.

Returns: this TypeId instance

Record in this TypeId the fact that a new attribute exists.

Definition at line 700 of file type-id.cc.

References ns3::AttributeValue::Copy(), ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Here is the call graph for this function:

template<typename T >

TypeId ns3::TypeId::AddConstructor ( void )

Returns: this TypeId instance

Record in this TypeId the fact that the default constructor is accessible.

Definition at line 418 of file type-id.h.

References ns3::Create(), DoAddConstructor(), and ns3::MakeCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::TypeId::AddTraceSource	(	std::string	name,
		std::string	help,
		Ptr< const TraceSourceAccessor >	accessor
	)

Parameters

name	the name of the new trace source
help	some help text which describes the purpose of this trace source.
accessor	a pointer to a TraceSourceAccessor which can be used to connect/disconnect sinks to this trace source.

Returns: this TypeId instance.

Definition at line 773 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::TypeId::DoAddConstructor ( Callback< ObjectBase * > callback )

private

Definition at line 681 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by AddConstructor().

Here is the call graph for this function:

Here is the caller graph for this function:

struct TypeId::AttributeInformation ns3::TypeId::GetAttribute ( uint32_t i ) const

Parameters

i	index into attribute array

Returns: the information associated to attribute whose index is i.

Definition at line 746 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by ns3::cell_tooltip_callback(), ns3::cell_tooltip_callback_config_default(), ns3::ObjectBase::ConstructSelf(), StaticInformation::DoGather(), ns3::AttributeIterator::DoIterate(), ns3::Resolver::DoResolve(), GetAttributeFullName(), ns3::AttributeDefaultIterator::Iterate(), LookupAttributeByName(), main(), PrintAttributes(), ns3::CommandLine::PrintAttributes(), ns3::Config::Reset(), and ns3::Config::SetDefaultFailSafe().

Here is the call graph for this function:

Here is the caller graph for this function:

std::string ns3::TypeId::GetAttributeFullName ( uint32_t i ) const

Parameters

i	index into attribute array

Returns: the full name associated to the attribute whose index is i.

Definition at line 752 of file type-id.cc.

References GetAttribute(), GetName(), ns3::TypeId::AttributeInformation::name, and NS_LOG_FUNCTION.

Referenced by ns3::cell_edited_callback_config_default(), ns3::ObjectBase::ConstructSelf(), and ns3::CommandLine::PrintAttributes().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::TypeId::GetAttributeN ( void ) const

Returns: the number of attributes associated to this TypeId

Definition at line 739 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by ns3::cell_tooltip_callback(), ns3::ObjectBase::ConstructSelf(), StaticInformation::DoGather(), ns3::AttributeIterator::DoIterate(), ns3::Resolver::DoResolve(), ns3::AttributeDefaultIterator::Iterate(), LookupAttributeByName(), main(), ns3::Packet::Print(), PrintAttributes(), ns3::CommandLine::PrintAttributes(), ns3::Config::Reset(), and ns3::Config::SetDefaultFailSafe().

Here is the call graph for this function:

Here is the caller graph for this function:

Callback< ObjectBase * > ns3::TypeId::GetConstructor ( void ) const

Returns: a callback which can be used to instanciate an object of this type.

Definition at line 723 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by PacketMetadataTest::CheckHistory(), ns3::ObjectFactory::Create(), PacketTest::DoCheck(), ns3::Packet::Print(), ns3::Packet::PrintByteTags(), and ns3::Packet::PrintPacketTags().

Here is the call graph for this function:

Here is the caller graph for this function:

std::string ns3::TypeId::GetGroupName ( void ) const

Returns: the name of the group associated to this TypeId.

Definition at line 650 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by ns3::CommandLine::PrintGroup(), and ns3::CommandLine::PrintGroups().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId::hash_t ns3::TypeId::GetHash ( void ) const

Returns: the hash of this interface.

Definition at line 666 of file type-id.cc.

References ns3::Singleton< T >::Get(), and m_tid.

Referenced by ns3::UniqueTypeIdTestCase::DoRun(), and ns3::LookupTimeTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

std::string ns3::TypeId::GetName ( void ) const

Returns: the name of this interface.

Definition at line 658 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by ns3::Packet::AddByteTag(), ns3::Packet::AddHeader(), ns3::Packet::AddPacketTag(), ns3::Packet::AddTrailer(), ns3::Object::AggregateObject(), ns3::cell_data_function_col_0(), ns3::cell_data_function_col_0_config_default(), ns3::cell_tooltip_callback(), ns3::cell_tooltip_callback_config_default(), ns3::ObjectBase::ConstructSelf(), PacketTest::DoCheck(), StaticInformation::DoGather(), ns3::AttributeIterator::DoIterate(), ns3::UniqueTypeIdTestCase::DoRun(), ns3::LookupTimeTestCase::DoRun(), ns3::LteHelper::EnableLogComponents(), GetAttributeFullName(), ns3::LteHelper::GetHandoverAlgorithmType(), ns3::MobilityHelper::GetMobilityModelType(), ns3::LteHelper::GetSchedulerType(), ns3::PacketMetadata::GetSerializedSize(), ns3::internal::APointerChecker< T >::GetUnderlyingTypeInformation(), ns3::MobilityHelper::Install(), ns3::AttributeDefaultIterator::Iterate(), main(), ns3::operator<<(), ns3::Packet::PeekHeader(), ns3::Packet::PeekTrailer(), ns3::Packet::Print(), ns3::CommandLine::PrintAttributes(), ns3::Packet::PrintByteTags(), ns3::CommandLine::PrintGroup(), ns3::CommandLine::PrintTypeIds(), ns3::Packet::RemoveHeader(), ns3::Packet::RemovePacketTag(), ns3::Packet::RemoveTrailer(), ns3::Packet::ReplacePacketTag(), ns3::PacketMetadata::Serialize(), ns3::ObjectFactory::Set(), ns3::ObjectFactory::SetTypeId(), ns3::AttributeIterator::StartVisitArrayItem(), ns3::AttributeIterator::StartVisitObject(), and ns3::AttributeIterator::StartVisitPointerAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::TypeId::GetParent ( void ) const

Returns: the parent of this TypeId

This method cannot fail. It will return itself if this TypeId has no parent. i.e., it is at the top of the TypeId hierarchy. Currently, this is the case for the TypeId associated to the Object class only.

Definition at line 625 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, NS_LOG_FUNCTION, and TypeId().

Referenced by ns3::cell_tooltip_callback(), ns3::ObjectBase::ConstructSelf(), ns3::Object::DoGetObject(), ns3::AttributeIterator::DoIterate(), IsChildOf(), LookupAttributeByName(), LookupTraceSourceByName(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::TypeId::GetRegistered ( uint32_t i )

static

Parameters

i index

Returns: the TypeId instance whose index is i.

Definition at line 582 of file type-id.cc.

References NS_LOG_FUNCTION, and TypeId().

Referenced by StaticInformation::DoGather(), ns3::UniqueTypeIdTestCase::DoRun(), ns3::LookupTimeTestCase::DoRun(), ns3::AttributeDefaultIterator::Iterate(), main(), ns3::CommandLine::PrintGroup(), ns3::CommandLine::PrintGroups(), ns3::CommandLine::PrintTypeIds(), and ns3::Config::Reset().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::TypeId::GetRegisteredN ( void )

static

Returns: the number of TypeId instances registered.

Definition at line 576 of file type-id.cc.

References ns3::Singleton< T >::Get(), and NS_LOG_FUNCTION_NOARGS.

Referenced by StaticInformation::DoGather(), ns3::UniqueTypeIdTestCase::DoRun(), ns3::LookupTimeTestCase::DoRun(), ns3::LookupTimeTestCase::DoSetup(), ns3::AttributeDefaultIterator::Iterate(), main(), ns3::CommandLine::PrintGroup(), ns3::CommandLine::PrintGroups(), ns3::CommandLine::PrintTypeIds(), ns3::LookupTimeTestCase::Report(), and ns3::Config::Reset().

Here is the call graph for this function:

Here is the caller graph for this function:

struct TypeId::TraceSourceInformation ns3::TypeId::GetTraceSource ( uint32_t i ) const

Parameters

i	index into trace source array.

Returns: detailed information about the requested trace source.

Definition at line 766 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by LookupTraceSourceByName(), main(), and PrintTraceSources().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::TypeId::GetTraceSourceN ( void ) const

Returns: the number of trace sources defined in this TypeId.

Definition at line 760 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by LookupTraceSourceByName(), main(), and PrintTraceSources().

Here is the call graph for this function:

Here is the caller graph for this function:

uint16_t ns3::TypeId::GetUid ( void ) const

Returns: the internal integer which uniquely identifies this TypeId.

This is really an internal method which users are not expected to use.

Definition at line 813 of file type-id.cc.

References m_tid, and NS_LOG_FUNCTION.

Referenced by ns3::ByteTagList::Add(), ns3::PacketMetadata::AddHeader(), ns3::PacketMetadata::AddTrailer(), ns3::PacketMetadata::Deserialize(), ns3::UniqueTypeIdTestCase::DoRun(), ns3::PacketMetadata::RemoveHeader(), and ns3::PacketMetadata::RemoveTrailer().

Here is the caller graph for this function:

bool ns3::TypeId::HasConstructor ( void ) const

Returns: true if this TypeId has a constructor

Definition at line 673 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by ns3::Packet::Print(), and ns3::Packet::PrintPacketTags().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::TypeId::HasParent ( void ) const

Definition at line 632 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by ns3::cell_tooltip_callback(), and ns3::AttributeIterator::DoIterate().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::TypeId::HideFromDocumentation ( void )

Definition at line 783 of file type-id.cc.

References ns3::Singleton< T >::Get(), m_tid, and NS_LOG_FUNCTION.

Referenced by TestObject::GetTypeId(), anonymous_namespace{object-test-suite.cc}::BaseA::GetTypeId(), AlternateTestObject::GetTypeId(), anonymous_namespace{object-test-suite.cc}::DerivedA::GetTypeId(), anonymous_namespace{object-test-suite.cc}::BaseB::GetTypeId(), and anonymous_namespace{object-test-suite.cc}::DerivedB::GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::TypeId::IsChildOf ( TypeId other ) const

Parameters

other a parent TypeId

Returns: true if the input TypeId is really a parent of this TypeId, false otherwise.

Calling this method is roughly similar to calling dynamic_cast except that you do not need object instances: you can do the check with TypeId instances instead.

Definition at line 639 of file type-id.cc.

References GetParent(), and NS_LOG_FUNCTION.

Referenced by StaticInformation::DoGather(), and ns3::PacketMetadata::ItemIterator::Next().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::TypeId::LookupAttributeByName	(	std::string	name,
		struct AttributeInformation *	info
	)		const

Parameters

name	the name of the requested attribute
info	a pointer to the TypeId::AttributeInformation data structure where the result value of this method will be stored.