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

Update BMI C++ header to match upstream with virtual dtor and correct namespace #26

Merged
merged 1 commit into from
Jun 11, 2024

Conversation

PhilMiller
Copy link
Contributor

@PhilMiller PhilMiller commented Jun 11, 2024

Cf NOAA-OWP/ngen#831 for the reasoning behind the virtual destructor inspiring the update.

The namespace change is to address the technicality that bmi::Bmi* is not actually equivalent to bmixx::Bmi*, even though the class definitions may be identical, and that difference technically entails Undefined Behavior when they're conflated in ngen.

Changes

  • Update the definition of the base class Bmi to match upstream with its virtual destructor
  • Use the same namespace bmi as upstream, and not a custom namespace bmixx to avoid UB

Testing

  1. CI

Notes

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • 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
  • Visually tested in supported browsers and devices (see checklist below 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

.github/workflows/ngen_integration.yaml Outdated Show resolved Hide resolved
.github/workflows/ngen_integration.yaml Outdated Show resolved Hide resolved
@hellkite500 hellkite500 merged commit 5b64baa into master Jun 11, 2024
4 of 8 checks passed
@hellkite500
Copy link
Member

Rerun CI after dependent PR's are merged.

@PhilMiller PhilMiller deleted the PhilMiller/bmi-virtual-dtor branch June 11, 2024 17:55
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.

2 participants