Skip to content

Fix #5449 - Eliminate the Singleton templated class and the StaticInitializer one #5450

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.

Sign up for GitHub

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

Jump to bottom
Merged
jmarrec merged 11 commits into from
Oct 23, 2025
Merged

Fix #5449 - Eliminate the Singleton templated class and the StaticInitializer one #5450

jmarrec merged 11 commits into from
Oct 23, 2025

Conversation

@jmarrec
Copy link
Collaborator

@jmarrec jmarrec commented Jul 4, 2025

Pull request overview

Pull Request Author

  • Model API Changes / Additions
  • Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
  • Model API methods are tested (in src/model/test)
  • EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
  • If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
  • If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
  • Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
  • All new and existing tests passes
  • If methods have been deprecated, update rest of code to use the new methods

Labels:

  • If change to an IDD file, add the label IDDChange
  • If breaking existing API, add the label APIChange
  • If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • Code Style, strip trailing whitespace, etc.
  • All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
  • Labeling is ok
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified

@jmarrec jmarrec self-assigned this Jul 4, 2025
@jmarrec jmarrec added Developer Issue Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. labels Jul 10, 2025
@jmarrec jmarrec marked this pull request as ready for review July 10, 2025 13:24
@jmarrec jmarrec force-pushed the 5449_RemoveSingleton_StaticInitializer branch from 57d2295 to e508aab Compare July 10, 2025 13:29
@github-actions
Copy link

github-actions bot commented Jul 10, 2025

🧪 Test Results Dashboard

Summary

Metric Value
Total Tests 4085
Passed 4076
Failed 9
Errors 0
Skipped 0
Success Rate 99.8%
Generated 2025-07-10 14:02:11 UTC

⚠️ Minor Issues Detected

🔍 Failed Tests (9 failures)

Linux-c++ (9 failures)

CLITest-test_bundle-bundle.CLITest-test_bundle-bundle (run1)

Error Message:

Failed

Full Details:

No details available
CLITest-test_bundle-bundle_git.CLITest-test_bundle-bundle_git (run1)

Error Message:

Failed

Full Details:

No details available
CLITest-test_bundle-bundle_native_embedded.CLITest-test_bundle-bundle_native_embedded (run1)

Error Message:

Failed

Full Details:

No details available
CLITest-test_bundle-bundle.CLITest-test_bundle-bundle (run2)

Error Message:

Failed

Full Details:

No details available
CLITest-test_bundle-bundle_git.CLITest-test_bundle-bundle_git (run2)

Error Message:

Failed

Full Details:

No details available
CLITest-test_bundle-bundle_native_embedded.CLITest-test_bundle-bundle_native_embedded (run2)

Error Message:

Failed

Full Details:

No details available
CLITest-test_bundle-bundle.CLITest-test_bundle-bundle (run3)

Error Message:

Failed

Full Details:

No details available
CLITest-test_bundle-bundle_git.CLITest-test_bundle-bundle_git (run3)

Error Message:

Failed

Full Details:

No details available
CLITest-test_bundle-bundle_native_embedded.CLITest-test_bundle-bundle_native_embedded (run3)

Error Message:

Failed

Full Details:

No details available

📊 Test Run Information

Run XML File Status
run1 results.xml ✅ Found
run2 results.xml ✅ Found
run3 results.xml ✅ Found

@jmarrec jmarrec force-pushed the 5449_RemoveSingleton_StaticInitializer branch from e508aab to 240a1c5 Compare August 12, 2025 15:54
@jmarrec jmarrec force-pushed the 5449_RemoveSingleton_StaticInitializer branch 2 times, most recently from 7dce082 to 6e04639 Compare October 22, 2025 10:40
jmarrec added 11 commits October 22, 2025 13:36
@jmarrec
Rip out IddFactorySingleton and replace with a Meyers Singleton
2dd446e
@jmarrec
Replace ScheduleTypeRegistrySingleton with a Meyers singleton
c2db9c2
@jmarrec
Replace QuantityFactorySingleton
264e32f
@jmarrec
Replace ScaleFactorySingleton
818d35c
@jmarrec
Replace UnitFactorySingleton
3c01cd0
@jmarrec
Replace QuantityConverterSingleton
6917f1f
@jmarrec
Bye bye Singleton.hpp, you'll not be missed at all.
1d029f3
@jmarrec
Remove useless imports of StaticInitializer
c551a46
@jmarrec
Removes StaticInitializer
9edd38b 
Remove StaticInitializer base class and related code from EnumBase

Modern C++ (since C++11) guarantees thread-safe initialization of function-local static variables,
including on MSVC (since Visual Studio 2015). This makes the custom StaticInitializer mechanism
obsolete.

Function-local statics like getNames(), getValues(), getLookupMap(), and getDescriptions() already
provide safe, lazy, and one-time initialization across threads.

Removing StaticInitializer simplifies the code, reduces complexity, and relies on standard, well-tested
language features available on all supported compilers.
@jmarrec
Remove the "warm up" of boost uuid generators and use thread_local
9a09e11 
cf ac9def0#diff-cc558918703beec128109296de26a8bc6392b17eeb0d445ff2cc160afa33577f
@jmarrec
And now we can swig the IddFactory directly. Which is useful to me (g…
6199dd7 
…rabbing older iddFiles in particular)
@jmarrec jmarrec force-pushed the 5449_RemoveSingleton_StaticInitializer branch from 6e04639 to 6199dd7 Compare October 22, 2025 11:37
@ci-commercialbuildings
Copy link
Collaborator

ci-commercialbuildings commented Oct 22, 2025 •
edited
Loading

CI Results for 6199dd7:

@jmarrec jmarrec merged commit f900db2 into develop Oct 23, 2025
2 of 6 checks passed
@jmarrec jmarrec deleted the 5449_RemoveSingleton_StaticInitializer branch October 23, 2025 14:20
jmarrec added a commit to openstudiocoalition/OpenStudioApplication that referenced this pull request Dec 8, 2025
@jmarrec
Replace ApplicationSingleton and replace with a Meyers singleton
d83c22c 
cf NREL/OpenStudio#5450
@jmarrec jmarrec mentioned this pull request Dec 8, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kbenne kbenne Awaiting requested review from kbenne

@joseph-robertson joseph-robertson Awaiting requested review from joseph-robertson

Assignees

@jmarrec jmarrec

Labels

Developer Issue Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Eliminate all uses of the Singleton templated class and use a Meyers singleton

3 participants

@jmarrec @ci-commercialbuildings