Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor forcing and data provider #446

Merged
merged 2 commits into from
Oct 5, 2022

Conversation

stcui007
Copy link
Contributor

Additions

include/forcing/OptionalWrappedDataProvider.hpp
include/forcing/WrappedDataProvider.hpp
test/forcing/OptionalWrappedDataProvider_Test.cpp

Removals

include/forcing/OptionalWrappedProvider.hpp
include/forcing/WrappedForcingProvider.hpp
test/forcing/OptionalWrappedProvider_Test.cpp

Changes

include/forcing/DeferredWrappedProvider.hpp
include/realizations/catchment/Bmi_Module_Formulation.hpp
include/realizations/catchment/Bmi_Multi_Formulation.hpp
src/realizations/catchment/Bmi_Multi_Formulation.cpp
test/CMakeLists.txt
test/realizations/catchments/Bmi_Cpp_Multi_Array_Test.cpp
test/realizations/catchments/Bmi_Multi_Formulation_Test.cpp

Testing

Screenshots

Notes

Todos

Checklist

  • [ x] PR has an informative and human-readable title
  • [x ] Changes are limited to a single goal (no scope creep)
  • [x ] Code can be automatically merged (no conflicts)
  • [x ] Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • [x ] Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist (automated report can be put here)

Target Environment support

  • Linux

@@ -32,7 +32,7 @@ namespace data_access {
* returning results from a nested call to the wrapped provider, this type's implementation ensures only the outputs
* set as provideable in this instance (i.e., the outer wrapper) are returned.
*/
class DeferredWrappedProvider : public WrappedForcingProvider
class DeferredWrappedProvider : public WrappedDataProvider
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In future we might should rename this class also... but fine for now.

@@ -15,7 +15,7 @@ using namespace std;
namespace data_access {
namespace test {
/**
* A trivial implementation, strictly for testing OptionalWrappedProvider.
* A trivial implementation, strictly for testing OptionalWrappedDataProvider.
*/
class TrivialForcingProvider : public GenericDataProvider {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose I should have included this class in the list of renames... or maybe I meant this one and wrote OptionalWrappedForcingProvider instead (likely)... but since this is test-specific and does represent forcing data in the test this is fine for now.

@mattw-nws mattw-nws linked an issue Oct 5, 2022 that may be closed by this pull request
@mattw-nws mattw-nws merged commit f93d024 into NOAA-OWP:master Oct 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor and remove deprecated ForcingProvider functions
2 participants