Skip to content

Commit

Permalink
Add note to docs to clarify non-virtual DEFINE_FIELD
Browse files Browse the repository at this point in the history
  • Loading branch information
oruebel committed Dec 22, 2024
1 parent f6b306b commit 7b88122
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/pages/devdocs/registered_types.dox
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,13 @@
* typename value and the `ElectrodesTable.getTypeName` automatic override returning
* the indicated typename instead of the classname.
*
* \note
* ``DEFINE_FIELD`` creates templated, non-virtual read functions. This means if we
* want to "redefine" a field in a child class by calling ``DEFINE_FIELD`` again, then
* the function will be "hidden" instead of "override". This is important to remember
* when casting a pointer to a base type, as in this case the implementation from the
* base type will be used since the function created by ``DEFINE_FIELD`` is not virtual.
*
*
* @subsection implement_registered_type_example Example: Implementing a new type
*
Expand Down

0 comments on commit 7b88122

Please sign in to comment.