[pelesh]

Description

Make template aliases private whenever possible. We create template aliases to make the code more readable and to propagate types from the base class to the derived classes. The aliases are intended to be used locally within a class.

Proposed changes

Make template aliases private and document exceptions where an alias needs to be public.

Checklist

• All tests pass.
• Code compiles cleanly with flags -Wall -Wpedantic -Wconversion -Wextra.
• The new code follows GridKit™ style guidelines.
• There are unit tests for the new code.
• The new code is documented.
• The feature branch is rebased with respect to the target branch.
• N/A The CHANGELOG.md has been updated to reflect the changes. If this is a minor PR that is part of a larger fix already included in the file, state so.

Further comments

[nkoukpaizan]

I like the approach overall! The read the docs failure looks unrelated to this PR.

There are a few more private/public/trait spots that need to be updated. I'm getting the following compilation errors with -DGRIDKIT_ENABLE_ZMQ=On.

GridKit/examples/Network/CoSim/CoSimClient.cpp:46:47: error: 'SignalNodeT' is a private
      member of 'GridKit::PhasorDynamics::SystemModel<double, unsigned long>'
   46 |   using SignalNodeT  = typename SystemModelT::SignalNodeT;
      |                                               ^
GridKit/examples/Network/CoSim/CoSimClient.cpp:242:17: note: in instantiation of
      template class 'CoSimClient<double, unsigned long>' requested here
  242 |   auto client = CoSimClient<ScalarT, IdxT>(sys,
      |                 ^
GridKit/GridKit/Model/PhasorDynamics/SystemModel.hpp:69:13: note: declared private here
   69 |       using SignalNodeT    = SignalNodeSetT::SignalNodeT;
      |             ^
1 error generated.

[read-the-docs-community]

Documentation build overview

📚 GridKit | 🛠️ Build #35279106 | 📁 Comparing 5126f69 against latest (4315301)

  🔍 Preview build  

77 files changed · + 7 added · ± 59 modified · - 11 deleted

+ Added

• api/reference/classGridKit_1_1Model_1_1ConfigurationChecks.html
• api/reference/classGridKit_1_1Model_1_1ParameterReader.html
• api/reference/file_GridKit_Model_ConfigurationChecks.hpp.html
• api/reference/file_GridKit_Model_EvaluatorTraits.hpp.html
• api/reference/file_GridKit_Model_ParameterReader.hpp.html
• api/reference/function_namespaceGridKit_1_1Testing_1af550c32b056c1e5ced7c5ead33e3fcbb.html
• api/reference/structGridKit_1_1Model_1_1EvaluatorTraits.html

± Modified

• genindex.html
• development/CHANGELOG.html
• development/CONTRIBUTING.html
• api/reference/classGridKit_1_1PhasorDynamics_1_1Branch.html
• api/reference/classGridKit_1_1PhasorDynamics_1_1BusBase.html
• api/reference/classGridKit_1_1PhasorDynamics_1_1BusSignalVoltageIn.html
• api/reference/classGridKit_1_1PhasorDynamics_1_1BusSignalVoltageOut.html
• api/reference/classGridKit_1_1PhasorDynamics_1_1Component.html
• api/reference/classGridKit_1_1PhasorDynamics_1_1ConstantSignalSource.html
• api/reference/classGridKit_1_1PhasorDynamics_1_1Controller_1_1Reecb.html
• and 49 more...

- Deleted

• api/reference/classGridKit_1_1PhasorDynamics_1_1BusFault.html
• api/reference/dir_GridKit_Model_PhasorDynamics_BusFault.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1a688a138fbd3d7f6a08b3e474496f2771.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1ac462ff3ce4dd5e49f8ea341c58c383c2.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1ad07447f57a589d38b98504a9ada9ccac.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1adbd99bf52e0ba1864a89a33c66065fc8.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1af5e4141351261054f3d5aa62eb231e7d.html
• api/reference/file_GridKit_Model_PhasorDynamics_BusFault_BusFault.hpp.html
• api/reference/file_GridKit_Model_PhasorDynamics_BusFault_BusFaultData.hpp.html
• api/reference/typedef_namespaceGridKit_1_1PhasorDynamics_1ae2aa91267342226bbb0b840ff8be1f65.html
• and 1 more...

[pelesh]

I believe I addressed comments from the review. @superwhiskers, I fixed warnings in the co-sim example. Please check if the fix is appropriate.

[superwhiskers]

seems fine to me. that flag wasn't used at all, i just didn't remove it when modifying the code to get it to work.