feat(clp-s): Add a method in SchemaReader to get number of messages of a schema

[wraymo]

Description

This PR adds a method in SchemaReader to get number of messages of a schema, which can be used by custom FilterClass to implement related methods.

Checklist

• The PR satisfies the contribution guidelines.
• This is a breaking change and that has been indicated in the PR title, OR this isn't a
  breaking change.
• Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Summary by CodeRabbit

• New Features
  • Introduced a new capability for retrieving the total number of messages in a data set for easier reference by users.

[coderabbitai]

Walkthrough

The pull request introduces a new public getter method, get_num_messages, to the SchemaReader class. This method returns the internal m_num_messages value as a uint64_t. The change does not impact any other functionalities or the control flow of the class; it simply augments the class’s interface to expose the total count of messages.

Changes

File	Change Summary
components/core/.../SchemaReader.hpp	Added new public method uint64_t get_num_messages() const to return m_num_messages.

Possibly related PRs

• feat(clp-s): Add an initialization method in SchemaReader that passes the column map to FilterClass. #709: Adds similar enhancements to the SchemaReader class by introducing new methods that improve access to its internal data.

Suggested reviewers

• gibber9809

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • 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 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 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 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. (Beta)
• @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 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)

components/core/src/clp_s/SchemaReader.hpp (1)

160-163: Documentation could be more detailed.

While the implementation is correct, consider enhancing the documentation to include:

• The purpose of this method in relation to FilterClass implementations
• Whether the count includes filtered messages
• Whether the count can change during iteration

Here's a suggested documentation improvement:

     /**
-     * @return the number of messages in the schema
+     * @return The total number of messages in the schema. This count represents all messages,
+     *         regardless of any active filters. The count remains constant during iteration.
+     *         This method is particularly useful for FilterClass implementations that need
+     *         to make decisions based on the total message count.
      */

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0f7f433 and 2b92bac.

📒 Files selected for processing (1)

• components/core/src/clp_s/SchemaReader.hpp (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.{cpp,hpp,java,js,jsx,ts,tsx}`: - Prefer `false ==

**/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

• components/core/src/clp_s/SchemaReader.hpp

⏰ Context from checks skipped due to timeout of 90000ms (12)

• GitHub Check: centos-stream-9-static-linked-bins
• GitHub Check: ubuntu-focal-static-linked-bins
• GitHub Check: centos-stream-9-dynamic-linked-bins
• GitHub Check: ubuntu-jammy-static-linked-bins
• GitHub Check: ubuntu-focal-dynamic-linked-bins
• GitHub Check: ubuntu-jammy-dynamic-linked-bins
• GitHub Check: build-macos (macos-14, false)
• GitHub Check: build-macos (macos-13, false)
• GitHub Check: lint-check (ubuntu-latest)
• GitHub Check: lint-check (macos-latest)
• GitHub Check: build-macos (macos-13, true)
• GitHub Check: build (macos-latest)