search

FairRootGroup / FairRoot

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

FairGeoSet ctor improvements / fixes #1531

Closed ChristianTackeGSI closed 3 months ago

ChristianTackeGSI commented 3 months ago

Especially remove the just introduced setMaxModules() API, which just does not fulfill the classes invariants.

fixes part of #1530

Checklist:

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The series of updates across various files predominantly streamline the initialization of `FairGeoSet` in constructors. Previously, properties like `fName` and `maxModules` were set individually. Now, these are being directly initialized using parameterized constructors, enhancing code simplicity and reducing redundancy. ## Changes | File Path | Change Summary | |-------------------------------------------------------------|------------------------------------------------------------------------------------------------------| | `.../pixelDetector/src/PixelGeo.cxx` | Simplified `PixelGeo` constructor by directly initializing `FairGeoSet` with "Pixel" and 10. | | `.../Tutorial3/simulation/...`
`.../propagator/src/...`
`.../passive/FairGeo*.cxx`
`.../simulation/Tutorial[1-4]/src/...`
`.../simulation/rutherford/src/...`
`templates/.../NewDetectorGeo.cxx` | Unified constructor modification across multiple files to directly initialize `FairGeoSet` with specific parameters. | | `fairroot/geobase/FairGeoSet.cxx`
`fairroot/geobase/FairGeoSet.h` | Removed default constructor and updated class variable initialization in `FairGeoSet`. Adjusted constructor parameters. |
Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between c230328774fd28b1f72aa887c7be883ad0702ef1 and ba9b4bbe7984a3404dca7a5469d7b4797cfb51ec.
Files selected for processing (19) * examples/MQ/pixelDetector/src/PixelGeo.cxx (1 hunks) * examples/advanced/Tutorial3/simulation/FairTestDetectorGeo.cxx (1 hunks) * examples/advanced/propagator/src/FairTutPropGeo.cxx (1 hunks) * examples/common/passive/FairGeoCave.cxx (2 hunks) * examples/common/passive/FairGeoMagnet.cxx (2 hunks) * examples/common/passive/FairGeoPipe.cxx (2 hunks) * examples/common/passive/FairGeoTarget.cxx (2 hunks) * examples/simulation/Tutorial1/src/FairTutorialDet1Geo.cxx (1 hunks) * examples/simulation/Tutorial2/src/FairTutorialDet2Geo.cxx (1 hunks) * examples/simulation/Tutorial4/src/mc/FairTutorialDet4Geo.cxx (1 hunks) * examples/simulation/rutherford/src/FairRutherfordGeo.cxx (1 hunks) * fairroot/geobase/FairGeoSet.cxx (1 hunks) * fairroot/geobase/FairGeoSet.h (3 hunks) * templates/NewDetector_root_containers/NewDetectorGeo.cxx (2 hunks) * templates/NewDetector_stl_containers/NewDetectorGeo.cxx (2 hunks) * templates/project_root_containers/NewDetector/NewDetectorGeo.cxx (2 hunks) * templates/project_root_containers/passive/MyGeoCave.cxx (2 hunks) * templates/project_stl_containers/NewDetector/NewDetectorGeo.cxx (2 hunks) * templates/project_stl_containers/passive/MyGeoCave.cxx (2 hunks)
Files skipped from review due to trivial changes (10) * examples/MQ/pixelDetector/src/PixelGeo.cxx * examples/advanced/Tutorial3/simulation/FairTestDetectorGeo.cxx * examples/advanced/propagator/src/FairTutPropGeo.cxx * examples/common/passive/FairGeoPipe.cxx * examples/simulation/Tutorial4/src/mc/FairTutorialDet4Geo.cxx * fairroot/geobase/FairGeoSet.cxx * templates/NewDetector_root_containers/NewDetectorGeo.cxx * templates/NewDetector_stl_containers/NewDetectorGeo.cxx * templates/project_root_containers/NewDetector/NewDetectorGeo.cxx * templates/project_stl_containers/NewDetector/NewDetectorGeo.cxx
Additional comments not posted (10)
examples/simulation/rutherford/src/FairRutherfordGeo.cxx (1)
`11-12`: Constructor initialization aligns with PR objectives.
examples/simulation/Tutorial1/src/FairTutorialDet1Geo.cxx (1)
`11-12`: Constructor initialization aligns with PR objectives.
examples/simulation/Tutorial2/src/FairTutorialDet2Geo.cxx (1)
`11-12`: Constructor initialization aligns with PR objectives.
examples/common/passive/FairGeoTarget.cxx (1)
`21-22`: Constructor initialization aligns with PR objectives.
examples/common/passive/FairGeoMagnet.cxx (1)
`21-22`: Constructor initialization aligns with PR objectives.
examples/common/passive/FairGeoCave.cxx (1)
`32-34`: Constructor initialization aligns with PR objectives.
templates/project_root_containers/passive/MyGeoCave.cxx (1)
`34-36`: Constructor initialization aligns with PR objectives.
templates/project_stl_containers/passive/MyGeoCave.cxx (1)
`34-36`: Constructor initialization aligns with PR objectives.
fairroot/geobase/FairGeoSet.h (2)
`65-65`: Default constructor set to default. This is a good practice for simplicity and maintainability unless the default behavior was previously customized. --- `66-70`: Parameterized constructor now accepts `name`, `maxMods`, and `maxSecs` directly. This change simplifies the initialization process and reduces potential errors by removing the need for separate setter methods.
--- 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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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.