F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Clarify specialization of GetInstanceTypeId()

Browse Source
This commit is contained in:
Tom Henderson
2025-01-07 10:38:53 -08:00
parent af9b91a791
commit b506ec1bc2
3 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES.md
View File

@@ -20,6 +20,7 @@ This file is a best-effort approach to solving this issue; we will do our best b
### Changes to existing API
* (core) ``Object::GetInstanceTypeId()`` can no longer be specialized by subclasses and any such subclass API should be deleted (the base class will handle it).
* (internet-apps) Added a parameter to the RADVD helper to announce a prefix without the autoconfiguration flag.
### Changes to build system
@@ -42,7 +43,6 @@ This file is a best-effort approach to solving this issue; we will do our best b
* (applications) Deprecated attributes `RemoteAddress` and `RemotePort` in UdpClient, UdpTraceClient and UdpEchoClient. They have been combined into a single `Remote` attribute.
* (applications) Deprecated attributes `ThreeGppHttpClient::RemoteServerAddress` and `ThreeGppHttpClient::RemoteServerPort`. They have been combined into a single `ThreeGppHttpClient::Remote` attribute.
* (core) Deprecated `SUPPORTED`, `DEPRECATED` and `OBSOLETE` in `TypeId` class. They have been replaced by `SupportLevel::{SUPPORTED,DEPRECATED,OBSOLETE}`, respectively.
* (core) ``Object::GetInstanceTypeId()`` can no longer be specialized by subclasses.
* (lr-wpan) ``LrWpanMac`` is now also aggregated to ``LrWpanNetDevice``.
* (stats) Deprecated ns3::NaN and ns3::isNaN to use std::nan and std::isnan in their place
* (tap-bridge) Deprecated "Gateway" attribute.

11
doc/manual/source/attributes.rst
View File

@@ -801,10 +801,13 @@ follows::
// continue on with constructor.
}
Beware that the object and all its derived classes must also implement
a :cpp:func:`GetInstanceTypeId()` method. Otherwise
the :cpp:func:`ObjectBase::ConstructSelf()` will not be able to read
the attributes.
Classes that derive from :cpp:class:`Object` can not implement (i.e., specialize)
a :cpp:func:`GetInstanceTypeId()` method; this method is marked `final`
in :cpp:class:`Object`. However, classes that instead derive from
:cpp:class:`ObjectBase` directly (in ns-3, this is usually packet headers and tags),
must implement :cpp:func:`GetInstanceTypeId()`. It is recommended that this
method simply return the value provided by :cpp:func:`GetTypeId()`; see the class
:cpp:class:`EthernetHeader` in `src/network/utils` directory as an example.
Adding Attributes
+++++++++++++++++

7
src/core/model/object-base.h
View File

@@ -175,9 +175,10 @@ class ObjectBase
/**
* 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.
* This method is provided by ns3::Object::GetInstanceTypeId
* but classes which derive from ns3::ObjectBase directly
* have to implement it themselves. Typically, this method should
* simply return the output of `GetTypeId()`.
*
* @return The TypeId associated to the most-derived type
* of this instance.