[Tutorial] How to create ROOT Dictionary for a custom class is a stand-alone C++ project #13205

atolosadelgado · 2023-07-07T11:52:36Z

Hi,

This Pull request:

This PR comes from this forum thread. This tutorial is a minimal working example about how to create a ROOT dictionary for a custom class, and its use for writing and reading a TTree.

Further changes may be needed before full integration into ROOT project.

Changes or fixes:

New folder added, tutorials/tree/dictionary

Checklist:

tested changes locally
updated the docs (if necessary)

and how it is used to write and read a TTree

phsft-bot · 2023-07-07T11:52:39Z

Can one of the admins verify this patch?

jalopezg-git · 2023-07-07T12:04:56Z

Many thanks, @atolosadelgado! This will be reviewed soon!

github-actions · 2023-07-08T22:27:06Z

Test Results

      3 files       3 suites 12h 40m 33s ⏱️
2 458 tests 2 457 ✔️ 1 💤 0 ❌
6 771 runs 6 771 ✔️ 0 💤 0 ❌

Results for commit 49ee1f3.

♻️ This comment has been updated with latest results.

jalopezg-git

Many thanks for the contribution, @atolosadelgado 🙂!

I have attached some comments though to further improve the code in the PR!

tutorials/tree/dictionary/CMakeLists.txt

tutorials/tree/dictionary/README.md

tutorials/tree/dictionary/writeTree.cpp

tutorials/tree/dictionary/readTree.cpp

Co-authored-by: Javier Lopez-Gomez <javier.lopez.gomez@cern.ch>

…d in root-project#13205 (comment)

root-project#13205 (comment)

atolosadelgado · 2023-07-11T12:03:13Z

Hi,

I implemented most of the changes, but I would need some indications for the rest:

Is there a standard header for ROOT files?
Remove reference in CMakeLists to configure method to configure the ROOT project before building it?
In general, let's also briefly describe here the steps required to read/write user-defined classes, i.e. why ROOT relies on dictionaries for class introspection, how to generate one, etc. Is a link to the ROOT documentation enough? In addition, I am not expert on the topic, I can not expand your points.
std::unique_ptr<TTree> seems to not work. Never used if before, do you have any idea what is failing?

Thank for your time and effort,
Alvaro

tutorials/tree/dictionary/writeTree.cpp

tutorials/tree/dictionary/readTree.cpp

tutorials/tree/dictionary/CMakeLists.txt

root-project#13205 (comment)

root-project#13205 (review)

atolosadelgado · 2023-08-14T07:58:26Z

Almost there +1! I have included some suggestions to apply before merging! I'll re-request review to @vepadulano and @bellenot.

Also note:
* I didn't see the changes suggested in [this comment](https://github.com/root-project/root/pull/13205#discussion_r1265655686) by @pcanal.

* `clang-format` suggestions will have to be applied before merging.

Hi Javier, thank you for your comments.

If I understood properly, the comment by P. Canal about the dot at the end of the branch name means that it is mandatory in this case to avoid degeneracy, and a good practice in general. For that reason the branch names in this tutorial end with a dot.

Regarding the README file, I have added your suggestion about the linkdef file. Would you add something else?

The files .c and .h now follow the clang-format style.

jalopezg-git

See comment. Also, I guess it builds and works out of the box, right? (didn't test it myself)

Regarding the README file, I have added your suggestion about the linkdef file. Would you add something else?

As a first version, I think it's okay as-is, but let's also see what @vepadulano and @pcanal think.

tutorials/tree/dictionary/writeTree.cxx

root-project#13205 (comment)

atolosadelgado · 2023-08-16T13:00:28Z

See comment. Also, I guess it builds and works out of the box, right? (didn't test it myself)

Regarding the README file, I have added your suggestion about the linkdef file. Would you add something else?

As a first version, I think it's okay as-is, but let's also see what @vepadulano and @pcanal think.

Hi Javier,

I have added some comments in the writeTree.cpp about the final dot in the branch name. In addition, I have added 2 sentences to the README.

Thank you for your patience.
Alvaro

jalopezg-git

I think it's essentially good to go 👍; I stil have to try that it builds and compiles without any issue though!

@vepadulano, @pcanal could you take another look too? If you also think it's ready, we could merge even this week.

jalopezg-git · 2023-08-24T13:53:25Z

@phsft-bot build

phsft-bot · 2023-08-24T13:53:32Z

Starting build on ROOT-performance-centos8-multicore/soversion, ROOT-ubuntu2204/nortcxxmod, ROOT-ubuntu2004/python3, mac11/noimt, mac12arm/cxx20, windows10/default
How to customize builds

phsft-bot · 2023-08-24T14:29:08Z

Build failed on ROOT-ubuntu2204/nortcxxmod.
Running on root-ubuntu-2204-3.cern.ch:/home/sftnight/build/workspace/root-pullrequests-build
See console output.

vepadulano

Thanks again for this nice work! I think it's a good demonstration of the dictionary capabilities. I left a last minor comment to make a clarification in the doc.

tutorials/tree/dictionary/CMakeLists.txt

vepadulano · 2023-08-24T15:17:56Z

One other suggestion that slipped through my review. 45 commits is probably too much for this PR and they should be squashed into one or a few more.

jalopezg-git · 2023-08-24T21:33:49Z

One other suggestion that slipped through my review. 45 commits is probably too much for this PR and they should be squashed into one or a few more.

Indeed, we could squash on merge into a single commit; what do you think, @atolosadelgado?

root-project#13205 (comment)

jalopezg-git · 2023-08-26T20:46:37Z

@phsft-bot build

phsft-bot · 2023-08-26T20:46:44Z

Starting build on ROOT-performance-centos8-multicore/soversion, ROOT-ubuntu2204/nortcxxmod, ROOT-ubuntu2004/python3, mac11/noimt, mac12arm/cxx20, windows10/default
How to customize builds

jalopezg-git

Many thanks for the contribution! I tried the tutorial and it works without any issue 👍! The PR will be merged after the CI test results are available.

phsft-bot · 2023-08-26T21:11:11Z

Build failed on ROOT-ubuntu2204/nortcxxmod.
Running on root-ubuntu-2204-1.cern.ch:/home/sftnight/build/workspace/root-pullrequests-build
See console output.

Failing tests:

Changes were addressed in one of the previous commits. Thanks for the review, Bertrand!

ferdymercury · 2023-08-28T07:40:09Z

tutorials/tree/dictionary/CMakeLists.txt

+#---Include a CMake module which makes use of the previous variables and loads modules 
+#   with useful macros or functions such as ROOT_GENERATE_DICTIONARY
+#   For further details: https://root-forum.cern.ch/t/how-to-integrate-root-into-my-project-with-cmake/37175
+include(${ROOT_USE_FILE})


This way of including ROOT is a bit outdated, see a more modern way here: https://cliutils.gitlab.io/modern-cmake/chapters/packages/ROOT.html

Thank you! I think those tips are worth to be included as part of the official ROOT documentation :)

…d-alone C++ project (root-project#13205) Added tutorial that illustrates how to create a ROOT dictionary for a custom class and how to read/write objects of a user-defined class in `TTree`.

Tutorial added, about how to create ROOT Dictionary for a custom class

d942c13

and how it is used to write and read a TTree

atolosadelgado requested review from bellenot and couet as code owners July 7, 2023 11:52

jalopezg-git self-assigned this Jul 7, 2023

jalopezg-git requested review from jblomer, pcanal and jalopezg-git and removed request for bellenot July 7, 2023 12:00

jalopezg-git added improvement in:Documentation labels Jul 7, 2023

jalopezg-git suggested changes Jul 11, 2023

View reviewed changes

atolosadelgado and others added 12 commits July 11, 2023 11:29

Update tutorials/tree/dictionary/README.md

b33ef85

Co-authored-by: Javier Lopez-Gomez <javier.lopez.gomez@cern.ch>

Update tutorials/tree/dictionary/CMakeLists.txt

0bbff47

Co-authored-by: Javier Lopez-Gomez <javier.lopez.gomez@cern.ch>

Update tutorials/tree/dictionary/README.md

1104f8e

Co-authored-by: Javier Lopez-Gomez <javier.lopez.gomez@cern.ch>

Update tutorials/tree/dictionary/data2Tree.cpp

74f5837

Co-authored-by: Javier Lopez-Gomez <javier.lopez.gomez@cern.ch>

Update tutorials/tree/dictionary/data2Tree.cpp

c8cf91d

Co-authored-by: Javier Lopez-Gomez <javier.lopez.gomez@cern.ch>

Update tutorials/tree/dictionary/readTree.cpp

566019d

Co-authored-by: Javier Lopez-Gomez <javier.lopez.gomez@cern.ch>

Update tutorials/tree/dictionary/writeTree.cpp

7bb519a

Co-authored-by: Javier Lopez-Gomez <javier.lopez.gomez@cern.ch>

Update tutorials/tree/dictionary/writeTree.cpp

5c87723

Co-authored-by: Javier Lopez-Gomez <javier.lopez.gomez@cern.ch>

Functions writeTree and readTree are now compiled separataly as state…

ee0adaa

…d in root-project#13205 (comment)

Unique pointer is used now for holding the TFile object as stated here

a476225

root-project#13205 (comment)

New line added to end of file as stated here

c7be2ca

root-project#13205 (comment)

delete half sentence, as stated here

3184750

root-project#13205 (comment)

pcanal reviewed Jul 12, 2023

View reviewed changes

tutorials/tree/dictionary/writeTree.cpp Outdated Show resolved Hide resolved

pcanal reviewed Jul 12, 2023

View reviewed changes

tutorials/tree/dictionary/readTree.cpp Outdated Show resolved Hide resolved

pcanal reviewed Jul 12, 2023

View reviewed changes

tutorials/tree/dictionary/CMakeLists.txt Outdated Show resolved Hide resolved

atolosadelgado added 3 commits August 14, 2023 09:29

Line removed according to

3ddec6f

root-project#13205 (comment)

Extended explanation about dictionary added, according to

03c72c6

root-project#13205 (comment)

clang format passes, as suggested in

7df705d

root-project#13205 (review)

jalopezg-git reviewed Aug 16, 2023

View reviewed changes

tutorials/tree/dictionary/writeTree.cxx Outdated Show resolved Hide resolved

alvarotd added 2 commits August 16, 2023 14:42

Note about the dot role at the end of the branch name, as suggested in

d835e4b

root-project#13205 (comment)

Little expansion of README file

63f13e3

Clang format is ok now...

f7f9fe4

jalopezg-git reviewed Aug 24, 2023

View reviewed changes

Merge branch 'root-project:master' into custom_class_tree_example

238b980

vepadulano approved these changes Aug 24, 2023

View reviewed changes

tutorials/tree/dictionary/CMakeLists.txt Outdated Show resolved Hide resolved

atolosadelgado and others added 2 commits August 25, 2023 09:16

Merge branch 'root-project:master' into custom_class_tree_example

9ae5a98

More details in CMakeList added, according to

49ee1f3

root-project#13205 (comment)

jalopezg-git self-requested a review August 26, 2023 20:46

jalopezg-git reviewed Aug 26, 2023

View reviewed changes

jalopezg-git approved these changes Aug 26, 2023

View reviewed changes

jalopezg-git merged commit 4993029 into root-project:master Aug 27, 2023
5 of 13 checks passed

ferdymercury reviewed Aug 28, 2023

View reviewed changes

atolosadelgado mentioned this pull request Apr 10, 2024

[ROOT_5159] Improve TTree documentation about SetMakeClass() #14583

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Tutorial] How to create ROOT Dictionary for a custom class is a stand-alone C++ project #13205

[Tutorial] How to create ROOT Dictionary for a custom class is a stand-alone C++ project #13205

atolosadelgado commented Jul 7, 2023 •

edited by jalopezg-git

Loading

phsft-bot commented Jul 7, 2023

jalopezg-git commented Jul 7, 2023

github-actions bot commented Jul 8, 2023 •

edited

Loading

jalopezg-git left a comment

atolosadelgado commented Jul 11, 2023

atolosadelgado commented Aug 14, 2023

jalopezg-git left a comment •

edited

Loading

atolosadelgado commented Aug 16, 2023

jalopezg-git left a comment

jalopezg-git commented Aug 24, 2023

phsft-bot commented Aug 24, 2023

phsft-bot commented Aug 24, 2023

vepadulano left a comment

vepadulano commented Aug 24, 2023

jalopezg-git commented Aug 24, 2023

jalopezg-git commented Aug 26, 2023

phsft-bot commented Aug 26, 2023

jalopezg-git left a comment

phsft-bot commented Aug 26, 2023

ferdymercury Aug 28, 2023

atolosadelgado Aug 28, 2023

[Tutorial] How to create ROOT Dictionary for a custom class is a stand-alone C++ project #13205

[Tutorial] How to create ROOT Dictionary for a custom class is a stand-alone C++ project #13205

Conversation

atolosadelgado commented Jul 7, 2023 • edited by jalopezg-git Loading

This Pull request:

Changes or fixes:

Checklist:

phsft-bot commented Jul 7, 2023

jalopezg-git commented Jul 7, 2023

github-actions bot commented Jul 8, 2023 • edited Loading

Test Results

jalopezg-git left a comment

Choose a reason for hiding this comment

atolosadelgado commented Jul 11, 2023

atolosadelgado commented Aug 14, 2023

jalopezg-git left a comment • edited Loading

Choose a reason for hiding this comment

atolosadelgado commented Aug 16, 2023

jalopezg-git left a comment

Choose a reason for hiding this comment

jalopezg-git commented Aug 24, 2023

phsft-bot commented Aug 24, 2023

phsft-bot commented Aug 24, 2023

vepadulano left a comment

Choose a reason for hiding this comment

vepadulano commented Aug 24, 2023

jalopezg-git commented Aug 24, 2023

jalopezg-git commented Aug 26, 2023

phsft-bot commented Aug 26, 2023

jalopezg-git left a comment

Choose a reason for hiding this comment

phsft-bot commented Aug 26, 2023

Failing tests:

ferdymercury Aug 28, 2023

Choose a reason for hiding this comment

atolosadelgado Aug 28, 2023

Choose a reason for hiding this comment

atolosadelgado commented Jul 7, 2023 •

edited by jalopezg-git

Loading

github-actions bot commented Jul 8, 2023 •

edited

Loading

jalopezg-git left a comment •

edited

Loading