92 void SetParent (uint16_t uid, uint16_t parent);
104 void SetSize (uint16_t uid, std::size_t size);
121 uint16_t
GetUid (std::string name)
const;
133 std::string
GetName (uint16_t uid)
const;
157 std::size_t
GetSize (uint16_t uid)
const;
209 const std::string &supportMsg =
"");
250 Ptr<const TraceSourceAccessor> accessor,
251 std::string callback,
252 TypeId::SupportLevel supportLevel = TypeId::SUPPORTED,
253 const std::string &supportMsg = "");
325 typedef std::vector<struct IidInformation>::const_iterator
Iterator;
366 static ns3::Hasher hasher ( Create<Hash::Function::Murmur3> () );
375 #define IID "IidManager"
381 #define IIDL IID << ": "
389 "Trying to allocate twice the same uid: " << name);
394 NS_LOG_ERROR (
"Hash chaining TypeId for '" << name <<
"'. "
395 <<
"This is not a bug, but is extremely unlikely. "
396 <<
"Please contact the ns3 developers.");
410 "Triplicate hash detected while chaining TypeId for '"
412 <<
"'. Please contact the ns3 developers for assistance.");
421 if (name > hinfo->
name)
438 information.
name = name;
442 information.
size = (std::size_t)(-1);
449 uint16_t uid =
static_cast<uint16_t
> (tuid);
452 m_namemap.insert (std::make_pair (name, uid));
473 information->
parent = parent;
487 information->
size = size;
515 namemap_t::const_iterator it =
m_namemap.find (name);
542 return information->
name;
558 uint16_t pid = information->
parent;
575 std::size_t size = information->
size;
587 NS_FATAL_ERROR (
"Requested constructor for " << information->
name <<
" but it does not have one.");
623 for (std::vector<struct TypeId::AttributeInformation>::const_iterator i = information->
attributes.begin ();
633 if (parent == information)
640 information = parent;
655 const std::string &supportMsg)
658 initialValue << accessor << checker <<
659 supportLevel << supportMsg);
661 if (name.find (
' ') != std::string::npos)
663 NS_FATAL_ERROR (
"Attribute name \"" << name <<
"\" may not contain spaces ' ', " <<
664 "encountered when registering TypeId \"" <<
665 information->
name <<
"\"");
670 "\" already registered on tid=\"" <<
671 information->
name <<
"\"");
693 NS_ASSERT (i < information->attributes.size ());
694 information->
attributes[i].initialValue = initialValue;
704 std::size_t size = information->
attributes.size ();
709 IidManager::GetAttribute (uint16_t uid, std::size_t i) const
712 struct IidInformation *information = LookupInformation (uid);
713 NS_ASSERT (i < information->attributes.size ());
715 return information->attributes[i];
726 for (std::vector<struct TypeId::TraceSourceInformation>::const_iterator i = information->
traceSources.begin ();
736 if (parent == information)
743 information = parent;
754 std::string callback,
756 const std::string &supportMsg)
759 accessor << callback <<
760 supportLevel << supportMsg);
765 "\" already registered on tid=\"" <<
766 information->
name <<
"\"");
788 IidManager::GetTraceSource (uint16_t uid, std::size_t i) const
791 struct IidInformation *information = LookupInformation (uid);
792 NS_ASSERT (i < information->traceSources.size ());
794 return information->traceSources[i];
834 NS_ASSERT_MSG (uid != 0,
"Assert in TypeId::LookupByName: " << name <<
" not found");
853 NS_ASSERT_MSG (uid != 0,
"Assert in TypeId::LookupByHash: 0x"
854 << std::hex <<
hash << std::dec <<
" not found");
894 if (tmp.
name == name)
903 std::cerr <<
"Attribute '" << name <<
"' is deprecated: "
911 "' is obsolete, with no fallback: " <<
918 while (nextTid != tid);
955 return parent !=
m_tid;
962 while (tmp != other && tmp != tmp.
GetParent ())
966 return tmp == other && *
this != other;
1003 return hasConstructor;
1020 const std::string &supportMsg)
1023 &initialValue << accessor << checker <<
1024 supportLevel << supportMsg);
1026 initialValue.
Copy (), accessor, checker,
1027 supportLevel, supportMsg);
1039 const std::string &supportMsg)
1042 &initialValue << accessor << checker <<
1043 supportLevel << supportMsg);
1045 initialValue.
Copy (), accessor, checker,
1046 supportLevel, supportMsg);
1084 TypeId::GetAttribute (std::size_t i) const
1104 TypeId::GetTraceSource (std::size_t i) const
1114 std::string callback,
1116 const std::string &supportMsg)
1119 accessor << callback <<
1120 supportLevel << supportMsg);
1123 supportLevel, supportMsg);
1149 if (tmp.
name == name)
1158 std::cerr <<
"TraceSource '" << name <<
"' is deprecated: "
1166 "' is obsolete, with no fallback: " <<
1173 while (nextTid != tid);
1216 std::string tidString;
1221 is.setstate (std::ios_base::badbit);
Hold a value for an Attribute.
virtual Ptr< AttributeValue > Copy(void) const =0
Generic Hash function interface.
uint32_t GetHash32(const char *buffer, const std::size_t size)
Compute 32-bit hash of a byte buffer.
Hasher & clear(void)
Restore initial state.
TypeId information manager.
@ HashChainFlag
Hash chaining flag.
uint16_t GetRegisteredN(void) const
Get the total number of type ids.
TypeId::hash_t GetHash(uint16_t uid) const
Get the hash of a type id.
std::map< TypeId::hash_t, uint16_t > hashmap_t
Type of the by-hash index.
uint16_t GetParent(uint16_t uid) const
Get the parent of a type id.
std::map< std::string, uint16_t > namemap_t
Type of the by-name index.
void SetAttributeInitialValue(uint16_t uid, std::size_t i, Ptr< const AttributeValue > initialValue)
Set the initial value of an Attribute.
void SetGroupName(uint16_t uid, std::string groupName)
Set the group name of a type id.
void SetParent(uint16_t uid, uint16_t parent)
Set the parent of a type id.
void SetSize(uint16_t uid, std::size_t size)
Set the size of the object class referred to by this id.
std::string GetGroupName(uint16_t uid) const
Get the group name of a type id.
bool HasTraceSource(uint16_t uid, std::string name)
Check if a type id has a given TraceSource.
uint16_t GetRegistered(uint16_t i) const
Get a type id by index.
Callback< ObjectBase * > GetConstructor(uint16_t uid) const
Get the constructor Callback of a type id.
std::size_t GetAttributeN(uint16_t uid) const
Get the number of attributes.
uint16_t GetUid(std::string name) const
Get a type id by name.
struct TypeId::TraceSourceInformation GetTraceSource(uint16_t uid, std::size_t i) const
Get the trace source by index.
void AddConstructor(uint16_t uid, Callback< ObjectBase * > callback)
Add a constructor Callback to this type id.
void HideFromDocumentation(uint16_t uid)
Mark this type id to be excluded from documentation.
std::string GetName(uint16_t uid) const
Get the name of a type id.
std::vector< struct IidInformation > m_information
The container of all type id records.
std::size_t GetTraceSourceN(uint16_t uid) const
Get the number of Trace sources.
std::size_t GetSize(uint16_t uid) const
Get the size of a type id.
struct IidManager::IidInformation * LookupInformation(uint16_t uid) const
Retrieve the information record for a type.
struct TypeId::AttributeInformation GetAttribute(uint16_t uid, std::size_t i) const
Get Attribute information by index.
bool MustHideFromDocumentation(uint16_t uid) const
Check if this TypeId should not be listed in documentation.
bool HasConstructor(uint16_t uid) const
Check if a type id has a constructor Callback.
bool HasAttribute(uint16_t uid, std::string name)
Check if a type id has a given Attribute.
static TypeId::hash_t Hasher(const std::string name)
Hashing function.
hashmap_t m_hashmap
The by-hash index.
std::vector< struct IidInformation >::const_iterator Iterator
Iterator type.
uint16_t AllocateUid(std::string name)
Create a new unique type id.
void AddAttribute(uint16_t uid, std::string name, std::string help, uint32_t flags, Ptr< const AttributeValue > initialValue, Ptr< const AttributeAccessor > accessor, Ptr< const AttributeChecker > checker, TypeId::SupportLevel supportLevel=TypeId::SUPPORTED, const std::string &supportMsg="")
Record a new attribute in a type id.
void AddTraceSource(uint16_t uid, std::string name, std::string help, Ptr< const TraceSourceAccessor > accessor, std::string callback, TypeId::SupportLevel supportLevel=TypeId::SUPPORTED, const std::string &supportMsg="")
Record a new TraceSource.
namemap_t m_namemap
The by-name index.
Smart pointer class similar to boost::intrusive_ptr.
static IidManager * Get(void)
Get a pointer to the singleton instance.
a unique identifier for an interface.
bool IsChildOf(TypeId other) const
Check if this TypeId is a child of another.
bool SetAttributeInitialValue(std::size_t i, Ptr< const AttributeValue > initialValue)
Set the initial value of an Attribute.
std::size_t GetTraceSourceN(void) const
Get the number of Trace sources.
TypeId SetParent(void)
Set the parent TypeId.
static TypeId LookupByName(std::string name)
Get a TypeId by name.
std::size_t GetAttributeN(void) const
Get the number of attributes.
TypeId SetSize(std::size_t size)
Set the size of this type.
bool HasParent(void) const
Check if this TypeId has a parent.
TypeId AddTraceSource(std::string name, std::string help, Ptr< const TraceSourceAccessor > accessor, std::string callback, SupportLevel supportLevel=SUPPORTED, const std::string &supportMsg="")
Record a new TraceSource.
struct TypeId::TraceSourceInformation GetTraceSource(std::size_t i) const
Get the trace source by index.
@ ATTR_SGC
The attribute can be read, and written at any time.
static bool LookupByHashFailSafe(hash_t hash, TypeId *tid)
Get a TypeId by hash.
static uint16_t GetRegisteredN(void)
Get the number of registered TypeIds.
uint16_t GetUid(void) const
Get the internal id of this TypeId.
hash_t GetHash(void) const
Get the hash.
Callback< ObjectBase * > GetConstructor(void) const
Get the constructor callback.
std::string GetAttributeFullName(std::size_t i) const
Get the Attribute name by index.
struct TypeId::AttributeInformation GetAttribute(std::size_t i) const
Get Attribute information by index.
std::string GetGroupName(void) const
Get the group name.
void SetUid(uint16_t uid)
Set the internal id of this TypeId.
uint16_t m_tid
The TypeId value.
TypeId SetGroupName(std::string groupName)
Set the group name.
static TypeId LookupByHash(hash_t hash)
Get a TypeId by hash.
static TypeId GetRegistered(uint16_t i)
Get a TypeId by index.
bool HasConstructor(void) const
Check if this TypeId has a constructor.
Ptr< const TraceSourceAccessor > LookupTraceSourceByName(std::string name) const
Find a TraceSource by name.
TypeId HideFromDocumentation(void)
Hide this TypeId from documentation.
bool MustHideFromDocumentation(void) const
Check if this TypeId should not be listed in documentation.
uint32_t hash_t
Type of hash values.
TypeId()
Default constructor.
TypeId GetParent(void) const
Get the parent of this TypeId.
std::string GetName(void) const
Get the name.
std::size_t GetSize(void) const
Get the size of this object.
bool LookupAttributeByName(std::string name, struct AttributeInformation *info) const
Find an Attribute by name, retrieving the associated AttributeInformation.
static bool LookupByNameFailSafe(std::string name, TypeId *tid)
Get a TypeId by name.
SupportLevel
The level of support or deprecation for attributes or trace sources.
@ SUPPORTED
Attribute or trace source is currently used.
@ OBSOLETE
Attribute or trace source is not used anymore; simulation fails.
@ DEPRECATED
Attribute or trace source is deprecated; user is warned.
TypeId AddAttribute(std::string name, std::string help, const AttributeValue &initialValue, Ptr< const AttributeAccessor > accessor, Ptr< const AttributeChecker > checker, SupportLevel supportLevel=SUPPORTED, const std::string &supportMsg="")
Record in this TypeId the fact that a new attribute exists.
void DoAddConstructor(Callback< ObjectBase * > callback)
Implementation for AddConstructor().
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
#define ATTRIBUTE_HELPER_CPP(type)
Define the attribute value, accessor and checkers for class type
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
#define NS_LOG_FUNCTION_NOARGS()
Output the name of the function.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
ns3::Hasher, ns3::Hash32() and ns3::Hash64() function declarations.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool operator<(const EventId &a, const EventId &b)
std::istream & operator>>(std::istream &is, Angles &a)
std::ostream & operator<<(std::ostream &os, const Angles &a)
ns3::Singleton declaration and template implementation.
ns3::TraceSourceAccessor and ns3::MakeTraceSourceAccessor declarations.
ns3::TypeId declaration; inline and template implementations.