Handle out of bounds error in nthIterval of FilteredTimeSeriesProperty #39238
+18
−1
Conversation
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
jhaigh0
requested changes
Apr 25, 2025
There was a problem hiding this comment.
Just one change for the test, otherwise works as intendended. output I go from running the script:
LoadMuonNexus started
Geometry cache is not available
Creating cache in C:\Users\bya67386\AppData\Roaming\mantidproject\mantid\instrument\geometryCache\HIFI7a5093e08ddd5090d58abd7fc3aab4d5cc1547e4.vtp
Sample Log "Field_Hall_Z" contains invalid values, click "Show Sample Logs" for details.
Sample Log "Field_Hall_Z" and 0 other contain invalid values, click "Show Sample Logs" for details.
Log "running" has 36 entries removed due to duplicated time.
LoadMuonNexus successful, Duration 3.30 seconds
RuntimeError: nthInterval(): FilteredTimeSeriesProperty 'Field_Main' interval 109 does not exist
File "<string>", line 6, in <module>
Comment on lines
157
to
165
| // Throw exception if out of bounds | ||
| if (n >= static_cast<int>(this->m_filterIntervals.size())) { | ||
| const std::string error("nthInterval(): FilteredTimeSeriesProperty '" + this->name() + "' interval " + | ||
| std::to_string(n) + " does not exist"); | ||
| g_log.debug(error); | ||
| throw std::runtime_error(error); | ||
| } else { | ||
| deltaT = this->m_filterIntervals[std::size_t(n)]; | ||
| } |
There was a problem hiding this comment.
You could do this with at(), supposed to be a safe way to access vectors, although it still throws an exception?
https://en.cppreference.com/w/cpp/container/array/at
Just letting you know about it, the code is fine as it is.
There was a problem hiding this comment.
Thanks, I think we want the custom error message in this case, in keeping with other error handling within the function.
MialLewis
force-pushed
the
0_add_bounds_check_to_nthTime
branch
from
702a794 to
384af75
Compare
jhaigh0
approved these changes
Apr 28, 2025
glass-ships
pushed a commit
that referenced
this pull request
Apr 28, 2025
#39238) * throw error if out of bounds in nthIterval * add release note * update nthInterval test * satisfy cppcheck - remove std::move to allow for nrvo * cast size_t to int to resolve compiler warnings * respond to review comments
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.
Description of work
Reported by a user, possible to provide an
nargument tonthTimeornthIntervalmethod of aFilteredTimeSeriesPropertyand get an out of bounds error.This PR adds bounds checking.
To test:
Ensure instrument is
HIFIand data archive access is available.Ensure error is handled when running the following script:
Reviewer
Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.
Code Review
Functional Tests
Does everything look good? Mark the review as Approve. A member of
@mantidproject/gatekeeperswill take care of it.Gatekeeper
If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.