FairRootGroup / FairRoot

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

refactor: Drop unneeded FRM references and empty methods #1577

Closed ChristianTackeGSI closed 1 month ago

ChristianTackeGSI commented 1 month ago

Checklist:

coderabbitai[bot] commented 1 month ago
Walkthrough ## Walkthrough The recent updates primarily focus on code cleanup and optimization across several components. Key changes include the removal of unused methods, updating copyright years, changing destructors to use the default keyword, and modifying method control flows. Additionally, there is a modernization of variable types and a shift from specific collection types to more generalized ones. ## Changes | **File(s)** | **Summary of Changes** | |-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| | `examples/MQ/pixelAlternative/src/PixelAltDigiWriteToRootVector.cxx` | Removed `Reset()`, updated destructor to default, adjusted method control flows, removed empty lines. | | `examples/MQ/pixelAlternative/src/PixelAltDigiWriteToRootVector.h` | Removed `Reset()` method. | | `examples/MQ/pixelDetector/src/PixelDigiWriteToFile.cxx` | Constructor initializes additional member, destructor set to default, `Exec` no longer calls `Reset()`. | | `examples/MQ/pixelDetector/src/PixelDigiWriteToFile.h` | Removed `Reset()` method. | | `examples/advanced/Tutorial3/MQ/processorTask/MQRecoTask.h` | Updated copyright year, removed `FairRootManager.h` inclusion. | | `examples/simulation/Tutorial2/src/FairTutorialDet2Digitizer.cxx` | Updated copyright year, removed commented-out code. | | `fairroot/base/event/FairEventBuilderManager.cxx` | Updated copyright year, `Init` method no longer checks for `FairRootManager` existence. | | `fairroot/base/sim/FairMCApplication.cxx` | Replaced `Int_t` with `auto`, changed `list` type from `THashList` to `TCollection`, commented out a logging statement. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant PixelAltDigiWriteToRootVector participant PixelDigiWriteToFile User ->> PixelAltDigiWriteToRootVector: Construct() PixelAltDigiWriteToRootVector -->> PixelAltDigiWriteToRootVector: Initialize without Reset() User ->> PixelDigiWriteToFile: Construct() PixelDigiWriteToFile -->> PixelDigiWriteToFile: Initialize with additional member User ->> PixelAltDigiWriteToRootVector: Exec() PixelAltDigiWriteToRootVector -->> PixelAltDigiWriteToRootVector: Execute without Reset() User ->> PixelDigiWriteToFile: Exec() PixelDigiWriteToFile -->> PixelDigiWriteToFile: Execute without Reset() ```

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 52836e5878a1c9e5e0ba9aec37111bfcba7379be and fccf342ccc1fb80ff7348167511d07b517455f45.
Files selected for processing (1) * fairroot/base/sim/FairMCApplication.cxx (3 hunks)
Additional comments not posted (2)
fairroot/base/sim/FairMCApplication.cxx (2)
`761-765`: **LGTM! The use of `auto` improves readability.** Replacing `Int_t` with `auto` for `NoOfVolumesBefore`, `ModId`, and `NoOfVolumes` enhances readability by reducing redundancy. --- `795-795`: **LGTM! Verify compatibility with `TCollection`.** Changing the type of `list` from `THashList` to `TCollection` can provide more flexibility. Ensure that all subsequent operations on `list` are compatible with `TCollection`.
Verification successful --- **Verified compatibility with `TCollection`.** The operations on `list` after its declaration are compatible with `TCollection`. These include null checks, reassignment, and iteration using `TRangeDynCast`. - Null check: `if (list == 0)` and `if (list != 0)` are valid for `TCollection`. - Reassignment: `list = pdgDatabase->ParticleList();` is valid for `TCollection`. - Iteration: `TRangeDynCast(list)` is compatible with `TCollection`.
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify all operations on `list` are compatible with `TCollection`. # Test: Search for operations on `list`. Expect: Compatibility with `TCollection`. rg --type cpp -A 5 $'TCollection* list' ``` Length of output: 40 --- Script: ```shell #!/bin/bash # Description: Verify all operations on `list` are compatible with `TCollection`. # Test: Search for operations on `list` after its declaration. rg --type cpp -A 10 'const TCollection\* list = pdgDatabase->ParticleList\(\);' ``` Length of output: 1006
--- 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.