Conversation
…, pragma once placement - Remove duplicate GribJumpBase.h include in GribJumpBase.cc - Reorder includes in Forwarder.cc, Range.cc, gribjump_c.cc, Request.cc (system headers first, then third-party, then project headers) - Move pragma once before includes in GribJumpFactory.h - Remove redundant GribJumpBase.h include from GribJump.h, add direct includes for types actually used (map, PathName, Metrics) - Fix GribJumpFactory.h to include Config.h directly instead of relying on transitive includes through GribJump.h
Move source files from flat layout into api/, core/, config/, plugins/ subdirectories and update all include paths across the codebase. Directory structure: - api/: Public API (GribJump, GribJumpBase, GribJumpFactory, gribjump_c, ExtractionData, ExtractionItem, ExtractionIterator, Types, GribJumpException) - core/: Internal engine (Engine, Task, Lister, Forwarder, LocalGribJump, URIHelper, GribJumpDataAccessor) - config/: Configuration (LibGribJump, Config, Metrics, Stats, LogRouter) - plugins/: FDB plugin Updated CMakeLists.txt source paths and all #include directives in src/, tests/, and tools/ to reflect new locations.
- Add full Doxygen blocks to 5 public API headers: GribJump.h, GribJumpBase.h, gribjump_c.h, ExtractionData.h, ExtractionItem.h - Create docs/Doxyfile for HTML API reference generation - Create docs/examples/simple_extract.cc minimal C++ extraction example - Create docs/examples/README.md with setup and run instructions
ResultsMap was defined in GribJumpBase.h but used in Engine.h and Request.h which only included Types.h. Move it to Types.h where all other type aliases live, resolving the undeclared identifier errors.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #86 +/- ##
===========================================
- Coverage 77.90% 77.89% -0.01%
===========================================
Files 97 97
Lines 4920 4923 +3
Branches 443 443
===========================================
+ Hits 3833 3835 +2
- Misses 1087 1088 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ChrisspyB
commented
Mar 20, 2026
src/gribjump/api/ExtractionData.h
Outdated
| /// @param s Input stream containing a serialised ExtractionResult. | ||
| explicit ExtractionResult(eckit::Stream& s); | ||
|
|
||
| /// @brief Copy construction is disabled (move-only type). |
Member
Author
There was a problem hiding this comment.
This kind of doc is not useful.
| /// @param filename File path. | ||
| /// @param scheme URI scheme (for example "file"). | ||
| /// @param offset Byte offset of the target GRIB message. | ||
| /// @param host Optional host for remote access. |
Member
Author
There was a problem hiding this comment.
The docs say host port are optional, but the implementation does not.
src/gribjump/compression/Range.cc
Outdated
| #include <algorithm> | ||
| #include <cassert> | ||
|
|
||
| #include "Range.h" |
Member
Author
There was a problem hiding this comment.
May as well update these to use full paths while we're at it
Member
Author
There was a problem hiding this comment.
Not actually a useful example without FDB archival.
Draft
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Some long awaited cleanup:
Contributor Declaration
By opening this pull request, I affirm the following: