search

FairRootGroup / FairRoot

C++ simulation, reconstruction and analysis framework for particle physics experiments
http://fairroot.gsi.de
Other
59 stars 96 forks source link

feat(base): Introduce FairDetector::GetRootManager #1568

Closed ChristianTackeGSI closed 4 months ago

ChristianTackeGSI commented 5 months ago

Especially classes deriving from FairDetector and implementing the Register member function need access to FairrootManager. Give them a proper getter.

Checklist:

coderabbitai[bot] commented 5 months ago
Walkthrough ## Walkthrough The changes primarily involve refactoring the registration methodology within various classes in the codebase to use `GetRootManager()` instead of directly accessing the singleton `FairRootManager::Instance()`. This update has been applied across multiple examples, templates, and core classes, likely to improve code modularity and maintainability. ## Changes | File/Directory | Change Summary | |---------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | examples/MQ/pixelDetector/src/Pixel.cxx | Changed method call from `FairRootManager::Instance()->Register` to `GetRootManager().Register` | | examples/advanced/Tutorial3/simulation/FairTestDetector.cxx | Refactored to use `GetRootManager().Register` instead of `FairRootManager::Instance()->Register` | | examples/advanced/propagator/src/FairTutPropDet.cxx | Updated `Register` method to use `GetRootManager()` and updated the copyright year to 2024 | | examples/simulation/Tutorial1/src/FairFastSimExample.cxx | Modified method call to use `GetRootManager().Register` instead of `FairRootManager::Instance()->Register` | | examples/simulation/Tutorial1/src/FairFastSimExample2.cxx | Changed registration method call to use `GetRootManager().Register` | | examples/simulation/Tutorial1/src/FairTutorialDet1.cxx | Updated method call for registration to `GetRootManager().Register` | | examples/simulation/Tutorial4/src/mc/FairTutorialDet4.cxx | Switched registration method to use `GetRootManager().Register` | | examples/simulation/rutherford/src/FairRutherford.cxx | Modified `FairRutherford` to use `GetRootManager()` for registration | | fairroot/base/sim/FairDetector.h | Added `#include `, method for setting/getting `RootManager`, and updated comments | | fairroot/base/sim/FairMCApplication.cxx | Updated `RegisterOutput` method to set `RootManager` for the detector | | fairroot/base/steer/FairRootManager.h | Added deprecation warning for `FairRootManager::Instance()` and suggested using specific getters instead | | templates/NewDetector_root_containers/NewDetector.cxx | Changed method calls for registration to use `GetRootManager().Register` based on simulation type | | templates/NewDetector_stl_containers/NewDetector.cxx | Updated `Register` method call to use `GetRootManager().RegisterAny` instead of `FairRootManager::Instance()->RegisterAny` | | templates/project_root_containers/MyProjGenerators/Pythia8Generator.cxx | Updated copyright year to 2024 and removed commented-out code | | templates/project_root_containers/NewDetector/NewDetector.cxx | Refactored `Register` method calls to use `GetRootManager().Register` and `GetRootManager().RegisterAny` based on condition related to `gMC->IsMT()` | | templates/project_stl_containers/MyProjGenerators/Pythia8Generator.cxx | Updated copyright year to 2024 and commented out code snippet related to creating a separate container using `FairRootManager` | | templates/project_stl_containers/NewDetector/NewDetector.cxx | Changed registration method call in `Register()` method to use `GetRootManager().RegisterAny` instead of `FairRootManager::Instance()->RegisterAny` | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant DetectorClass participant FairRootManager participant RootManager DetectorClass ->> RootManager: GetRootManager() activate RootManager RootManager ->> DetectorClass: Return RootManager instance deactivate RootManager DetectorClass ->> RootManager: Register("CollectionName", "CollectionType", collection, kTRUE) ```
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 8e3a27971018ad5ae9a0525dacdb3d6de8ed74f8 and ec56c6fb46818cb75b8d9b213b008199c24aeb8e.
Files selected for processing (17) * examples/MQ/pixelDetector/src/Pixel.cxx (2 hunks) * examples/advanced/Tutorial3/simulation/FairTestDetector.cxx (2 hunks) * examples/advanced/propagator/src/FairTutPropDet.cxx (2 hunks) * examples/simulation/Tutorial1/src/FairFastSimExample.cxx (2 hunks) * examples/simulation/Tutorial1/src/FairFastSimExample2.cxx (2 hunks) * examples/simulation/Tutorial1/src/FairTutorialDet1.cxx (2 hunks) * examples/simulation/Tutorial4/src/mc/FairTutorialDet4.cxx (2 hunks) * examples/simulation/rutherford/src/FairRutherford.cxx (2 hunks) * fairroot/base/sim/FairDetector.h (6 hunks) * fairroot/base/sim/FairMCApplication.cxx (1 hunks) * fairroot/base/steer/FairRootManager.h (2 hunks) * templates/NewDetector_root_containers/NewDetector.cxx (1 hunks) * templates/NewDetector_stl_containers/NewDetector.cxx (1 hunks) * templates/project_root_containers/MyProjGenerators/Pythia8Generator.cxx (2 hunks) * templates/project_root_containers/NewDetector/NewDetector.cxx (1 hunks) * templates/project_stl_containers/MyProjGenerators/Pythia8Generator.cxx (2 hunks) * templates/project_stl_containers/NewDetector/NewDetector.cxx (1 hunks)
Files skipped from review as they are similar to previous changes (16) * examples/MQ/pixelDetector/src/Pixel.cxx * examples/advanced/Tutorial3/simulation/FairTestDetector.cxx * examples/advanced/propagator/src/FairTutPropDet.cxx * examples/simulation/Tutorial1/src/FairFastSimExample.cxx * examples/simulation/Tutorial1/src/FairFastSimExample2.cxx * examples/simulation/Tutorial1/src/FairTutorialDet1.cxx * examples/simulation/Tutorial4/src/mc/FairTutorialDet4.cxx * examples/simulation/rutherford/src/FairRutherford.cxx * fairroot/base/sim/FairDetector.h * fairroot/base/sim/FairMCApplication.cxx * templates/NewDetector_root_containers/NewDetector.cxx * templates/NewDetector_stl_containers/NewDetector.cxx * templates/project_root_containers/MyProjGenerators/Pythia8Generator.cxx * templates/project_root_containers/NewDetector/NewDetector.cxx * templates/project_stl_containers/MyProjGenerators/Pythia8Generator.cxx * templates/project_stl_containers/NewDetector/NewDetector.cxx
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.