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 }

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
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	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

Definition at line 44 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 50 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 372 of file type-id.cc.

References m_tid, and NS_ASSERT.

ns3::TypeId::TypeId ( )

inline

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

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

Here is the caller graph for this function:

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

inline

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

ns3::TypeId::~TypeId ( )

inline

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

ns3::TypeId::TypeId ( uint16_t tid )

explicitprivate

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

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 497 of file type-id.cc.

References ATTR_SGC, ns3::AttributeValue::Copy(), and m_tid.

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 508 of file type-id.cc.

References ns3::AttributeValue::Copy(), and m_tid.

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 388 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 572 of file type-id.cc.

References m_tid.

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

private

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

References m_tid.

Referenced by AddConstructor().

Here is the caller graph for this function:

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

read

Parameters

i	index into attribute array

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

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

References m_tid.

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 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 554 of file type-id.cc.

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

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 543 of file type-id.cc.

References m_tid.

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 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 529 of file type-id.cc.

References m_tid.

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

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 470 of file type-id.cc.

References m_tid.

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

Here is the caller graph for this function:

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

Returns: the name of this interface.

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

References m_tid.

Referenced by ns3::BridgeNetDevice::AddBridgePort(), 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(), ns3::PacketTest::DoCheck(), StaticInformation::DoGather(), ns3::AcousticModemEnergyModelHelper::DoInstall(), ns3::WifiRadioEnergyModelHelper::DoInstall(), ns3::AttributeIterator::DoIterate(), ns3::LteHelper::EnableLogComponents(), ns3::BridgeNetDevice::ForwardBroadcast(), ns3::BridgeNetDevice::ForwardUnicast(), GetAttributeFullName(), ns3::MobilityHelper::GetMobilityModelType(), 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::Packet::PrintByteTags(), ns3::CommandLine::PrintGroup(), ns3::CommandLine::PrintTypeIds(), ns3::Node::ReceiveFromDevice(), ns3::Packet::RemoveHeader(), ns3::Packet::RemovePacketTag(), ns3::Packet::RemoveTrailer(), ns3::PacketMetadata::Serialize(), ns3::ObjectFactory::Set(), ns3::AnimationInterface::StartAnimation(), ns3::AttributeIterator::StartVisitArrayItem(), ns3::AttributeIterator::StartVisitObject(), and ns3::AttributeIterator::StartVisitPointerAttribute().

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 448 of file type-id.cc.

References m_tid, 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 409 of file type-id.cc.

References TypeId().

Referenced by StaticInformation::DoGather(), 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 404 of file type-id.cc.

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

Here is the caller graph for this function:

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

read

Parameters

i	index into trace source array.

Returns: detailed information about the requested trace source.

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

References m_tid.

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

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 561 of file type-id.cc.

References m_tid.

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

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 609 of file type-id.cc.

References m_tid.

Referenced by ns3::ByteTagList::Add(), ns3::PacketMetadata::AddHeader(), ns3::PacketMetadata::AddTrailer(), ns3::PacketMetadata::Deserialize(), 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 484 of file type-id.cc.

References m_tid.

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

Here is the caller graph for this function:

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

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

References m_tid.

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

Here is the caller graph for this function:

TypeId ns3::TypeId::HideFromDocumentation ( void )

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

References m_tid.

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 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 460 of file type-id.cc.

References GetParent().

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.

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

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

References GetAttribute(), GetAttributeN(), GetParent(), and ns3::TypeId::AttributeInformation::name.

Referenced by ns3::operator>>(), and ns3::ObjectFactory::Set().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::TypeId::LookupByName ( std::string name )

static

Parameters

name	the name of the requested TypeId

Returns: the unique id associated with the requested name.

This method cannot fail: it will crash if the input name is not a valid TypeId name.

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

References NS_ASSERT_MSG, and TypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

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

static

Parameters

name	the name of the requested TypeId
tid	a pointer to the TypeId instance where the result of this function should be stored.

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

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

References TypeId().

Referenced by ns3::Ns3NscStack::GetInstanceTypeId(), ns3::operator>>(), ns3::CommandLine::PrintAttributes(), and ns3::Config::SetDefaultFailSafe().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters

name	the name of the requested trace source

Returns: the trace source accessor which can be used to connect and disconnect trace sinks with the requested trace source on an object instance.

If no matching trace source is found, this method returns zero.

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

References ns3::TypeId::TraceSourceInformation::accessor, GetParent(), GetTraceSource(), GetTraceSourceN(), and ns3::TypeId::TraceSourceInformation::name.

Referenced by ns3::ObjectBase::TraceConnect(), ns3::ObjectBase::TraceConnectWithoutContext(), ns3::ObjectBase::TraceDisconnect(), and ns3::ObjectBase::TraceDisconnectWithoutContext().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Returns: true if this TypeId should be hidden from the user, false otherwise.

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

References m_tid.

Referenced by ns3::AttributeDefaultIterator::Iterate(), and main().

Here is the caller graph for this function:

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

inline

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

References m_tid.

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

Parameters

i	the attribute to manipulate
initialValue	the new initial value to use for this attribute.

Returns: true if the call was successfuly, false otherwise.

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

References m_tid.

Referenced by ns3::Config::Reset(), and ns3::Config::SetDefaultFailSafe().

Here is the caller graph for this function:

TypeId ns3::TypeId::SetGroupName ( std::string groupName )

Parameters

groupName the name of the group this TypeId belongs to.

Returns: this TypeId instance.

The group name is purely an advisory information used to group together types according to a user-specific grouping scheme.

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

References m_tid.

TypeId ns3::TypeId::SetParent ( TypeId tid )

Parameters

tid	the TypeId of the base class.

Returns: this TypeId instance.

Record in this TypeId which TypeId is the TypeId of the base class of the subclass.

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

References m_tid.

template<typename T >

TypeId ns3::TypeId::SetParent ( void )

Returns: this TypeId instance.

Record in this TypeId which TypeId is the TypeId of the base class of the subclass.

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

void ns3::TypeId::SetUid ( uint16_t tid )

Parameters

tid	the internal integer which uniquely identifies this TypeId.

This method is even more internal than TypeId::GetUid. Use at your own risk and don't be surprised that it eats raw babies on full-moon nights.

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

References m_tid.

Referenced by ns3::PacketMetadata::GetSerializedSize(), ns3::ByteTagList::Iterator::Next(), ns3::PacketMetadata::ItemIterator::Next(), and ns3::PacketMetadata::Serialize().

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class AttributeList

friend

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

bool operator!=	(	TypeId	a,
		TypeId	b
	)

friend

bool operator<	(	TypeId	a,
		TypeId	b
	)

friend

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

bool operator==	(	TypeId	a,
		TypeId	b
	)

friend

Member Data Documentation

uint16_t ns3::TypeId::m_tid

private

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

Referenced by AddAttribute(), AddTraceSource(), DoAddConstructor(), GetAttribute(), GetAttributeN(), GetConstructor(), GetGroupName(), GetName(), GetParent(), GetTraceSource(), GetTraceSourceN(), GetUid(), HasConstructor(), HasParent(), HideFromDocumentation(), MustHideFromDocumentation(), ns3::operator!=(), ns3::operator<(), operator=(), ns3::operator==(), SetAttributeInitialValue(), SetGroupName(), SetParent(), SetUid(), and TypeId().

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

src/core/model/type-id.h
src/core/model/type-id.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation