Document I/O interfaces #648
Merged
Conversation
This file contains 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
hegner
requested changes
Jul 25, 2024
include/podio/Reader.h
Outdated
| /// data from the passed files | ||
| /// | ||
| /// @throws std::runtime_error in case the file extensions differ or in case | ||
| /// support for the necessary I/O backend has not been built | ||
| Reader makeReader(const std::vector<std::string>& filename); |
There was a problem hiding this comment.
actually it should be filenames, not filename
include/podio/Reader.h
Outdated
| /// reading. All files are assumed to be of the same I/O format, no switching | ||
| /// between formats is possible. | ||
| /// | ||
| /// @note For SIO files this will only read the first file! |
There was a problem hiding this comment.
we should put in some exception handling or something of that kind. That is too burried in the docs.
There was a problem hiding this comment.
You mean, throw an exception when more than one SIO file is passed?
There was a problem hiding this comment.
we should not silently ignore faulty states.
| /// backend specific readers that this class wraps. In contrast to the lower | ||
| /// level readers that usually return arbitrary FrameData, this interface class | ||
| /// will return fully constructed Frames. | ||
| /// |
There was a problem hiding this comment.
In addition it provides convenience methods to deal specifically with the event frame category...
|
Thanks for checking. I think I addressed all of them. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
BEGINRELEASENOTES
ReaderandWriterinterface classesmakeReaderthrows an exception if multiple SIO files are passed (see #647)ENDRELEASENOTES