fix(sim) Add GetSaveCurrentEvent() to FairMCApplication #1605

karabowi · 2025-06-10T13:52:21Z

Allows the user to get the state of the fSaveCurrentEvent flag.

Fixes issue #1604.

Checklist:

Followed the Contributing Guidelines

coderabbitai · 2025-06-10T13:53:43Z

📝 Walkthrough

Walkthrough

A new public getter method, GetSaveCurrentEvent(), was added to the FairMCApplication class. This method provides read access to the private boolean flag fSaveCurrentEvent, complementing the existing setter for this flag.

Changes

File	Change Summary
fairroot/base/sim/FairMCApplication.h	Added public getter method `GetSaveCurrentEvent()`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FairMCApplication

    User->>FairMCApplication: Call SetSaveCurrentEvent(value)
    FairMCApplication-->>FairMCApplication: Set fSaveCurrentEvent = value

    User->>FairMCApplication: Call GetSaveCurrentEvent()
    FairMCApplication-->>User: Return fSaveCurrentEvent

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- 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 explain this code block.
- @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

fairroot/base/sim/FairMCApplication.h (1)
222-226: Fix typo and add const qualifier for better design.

The getter implementation is correct and follows good naming conventions. However, there are two minor improvements:

Fix the typo "goint" → "going" in the documentation

Add const qualifier since the method doesn't modify object state

Apply this diff to improve the method:
-    /**
-     * Returns the state of the flag deciding whether the current event
-     * is goint to be stored.
-     */
-    Bool_t GetSaveCurrentEvent() { return fSaveCurrentEvent; }
+    /**
+     * Returns the state of the flag deciding whether the current event
+     * is going to be stored.
+     */
+    Bool_t GetSaveCurrentEvent() const { return fSaveCurrentEvent; }
The addition successfully addresses the PR objective of providing read access to the fSaveCurrentEvent flag and complements the existing setter nicely.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d16b36a and 2210847.

📒 Files selected for processing (1)

fairroot/base/sim/FairMCApplication.h (1 hunks)

ChristianTackeGSI

Please update the copyright header of changed files to include the current year.

fairroot/base/sim/FairMCApplication.h

Allows the user to get the state of the fSaveCurrentEvent flag. Fixes issue FairRootGroup#1604.

Allows the user to get the state of the fMarkFill flag. Fixes issue FairRootGroup#1604.

ChristianTackeGSI · 2025-06-14T08:04:28Z

Thanks! :-)

Small bits…

fix(sim)
fix(steer)

Yes, you're "fixing" an issue. I'd call it resolving an issue.

The issue IMHO is a feature request.
I'd suggest "feat(sim)" / "feat(steer)". You're adding more (public) functionality.

P.S.: I hope the CI gets fixed at some point…

ChristianTackeGSI

While you work on these, maybe move the initializers for fSaveCurrentEvent and fMarkFill to default member initializers?

ChristianTackeGSI · 2025-06-14T11:37:34Z

fairroot/base/sim/FairMCApplication.h

+    /**
+     * Returns the state of the flag deciding whether the current event
+     * is goint to be stored.
+     */


Fix the typo: "going"

ChristianTackeGSI · 2025-06-14T11:59:02Z

fairroot/base/sim/FairMCApplication.h

+     * Returns the state of the flag deciding whether the current event
+     * is goint to be stored.
+     */
+    bool GetSaveCurrentEvent() { return fSaveCurrentEvent; }


Mark this as const

Suggested change

bool GetSaveCurrentEvent() { return fSaveCurrentEvent; }

bool GetSaveCurrentEvent() const { return fSaveCurrentEvent; }

ChristianTackeGSI · 2025-06-14T11:59:34Z

fairroot/base/steer/FairRun.h

@@ -154,6 +154,9 @@ class FairRun : public TNamed
    //** Mark/Unmark event to be filled into output. Default is TRUE. */
    void MarkFill(Bool_t flag) { fMarkFill = flag; }

+    //** Get the state of the flag deciding whether the current event is goint to be stored. */


Please use consistant Doxygen formatting everywhere.

coderabbitai bot reviewed Jun 10, 2025

View reviewed changes

ChristianTackeGSI reviewed Jun 12, 2025

View reviewed changes

fairroot/base/sim/FairMCApplication.h Outdated Show resolved Hide resolved

karabowi force-pushed the fix_1604 branch from 2210847 to c98295b Compare June 13, 2025 09:34

karabowi added 2 commits June 13, 2025 11:39

fix(sim): Add GetSaveCurrentEvent() to FairMCApplication

2d78ca8

Allows the user to get the state of the fSaveCurrentEvent flag. Fixes issue FairRootGroup#1604.

fix(steer): Add GetMarkFill() to FairRun

7dae0b8

Allows the user to get the state of the fMarkFill flag. Fixes issue FairRootGroup#1604.

karabowi force-pushed the fix_1604 branch from c98295b to 7dae0b8 Compare June 13, 2025 09:39

ChristianTackeGSI reviewed Jun 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(sim) Add GetSaveCurrentEvent() to FairMCApplication #1605

fix(sim) Add GetSaveCurrentEvent() to FairMCApplication #1605

Uh oh!

karabowi commented Jun 10, 2025

Uh oh!

coderabbitai bot commented Jun 10, 2025

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

ChristianTackeGSI left a comment •

edited

Loading

Uh oh!

Uh oh!

ChristianTackeGSI commented Jun 14, 2025

Uh oh!

ChristianTackeGSI left a comment

Uh oh!

ChristianTackeGSI Jun 14, 2025

Uh oh!

ChristianTackeGSI Jun 14, 2025

Uh oh!

ChristianTackeGSI Jun 14, 2025 •

edited

Loading

Uh oh!

Uh oh!

	bool GetSaveCurrentEvent() { return fSaveCurrentEvent; }
	bool GetSaveCurrentEvent() const { return fSaveCurrentEvent; }

fix(sim) Add GetSaveCurrentEvent() to FairMCApplication #1605

Are you sure you want to change the base?

fix(sim) Add GetSaveCurrentEvent() to FairMCApplication #1605

Uh oh!

Conversation

karabowi commented Jun 10, 2025

Uh oh!

coderabbitai bot commented Jun 10, 2025

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

ChristianTackeGSI left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ChristianTackeGSI commented Jun 14, 2025

Uh oh!

ChristianTackeGSI left a comment

Choose a reason for hiding this comment

Uh oh!

ChristianTackeGSI Jun 14, 2025

Choose a reason for hiding this comment

Uh oh!

ChristianTackeGSI Jun 14, 2025

Choose a reason for hiding this comment

Uh oh!

ChristianTackeGSI Jun 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CodeRabbit Configuration File (`.coderabbit.yaml`)

ChristianTackeGSI left a comment •

edited

Loading

ChristianTackeGSI Jun 14, 2025 •

edited

Loading