Fix #4544 - CoilCoolingDX::clone crashes when called with another model

[jmarrec]

Pull request overview

• Fix CoilCoolingDX::clone crashes when called with another model #4544
• CoilCoolingDX::clone crashes when called with another model, because we have an issue where a component has a resourceobject which has a resource object, AND everyone lists them in the children() method.
• I went around in circles trying to make it work and retain it in the children method, but I decided not to, because really they shouldn't be listed

I don't think this qualifies as an "APIChange" because the API didn't change. It'll require downstream users to update their code (OSapp at least)

Pull Request Author

• Model API Changes / Additions
• Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
• [x) 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

[ci-commercialbuildings]

CI Results for 78dfcf1:

• Ubuntu 18.04:

• Ubuntu 20.04:

  • OpenStudio-3.6.0-alpha+78dfcf177e-Ubuntu-20.04.deb
  • OpenStudio-3.6.0-alpha+78dfcf177e-Ubuntu-20.04.tar.gz
  • perf_test/results.html

• Darwin:

  • OpenStudio-3.6.0-alpha+f503a0cf3c-Darwin-x86_64.dmg
  • OpenStudio-3.6.0-alpha+f503a0cf3c-Darwin-x86_64.tar.gz

• Windows:

• Code Coverage:

[kbenne]

Why not just remove this line instead of a comment?

[kbenne]

What is the strategy over in the App if performance objects are no longer children? Is there a corresponding change to App to specialize the IG for this type? Or maybe instead it is just ok to not show the performance data? I'm just asking out of curiousity. I agree that the main impact of this PR pertains to the App's inspector.

[wenyikuang]

I rebased the change(s) onto my codebase and rebuild and cause the failure of serveral tests.

[  FAILED  ] 3 tests, listed below:
[  FAILED  ] ModelFixture.CoilCoolingDX_clone
[  FAILED  ] ModelFixture.CoilCoolingDXCurveFitPerformance_clone
[  FAILED  ] ModelFixture.CoilCoolingDXCurveFitOperatingMode_clone

Do you mind review the tests?

[jmarrec]

Yeah, I'm still not sure how to fix it properly. I need to revisit this at some point.

[wenyikuang]

I deep dived into the unittests and find the issue is happening in

  EXPECT_EQ(0u, model.getConcreteModelObjects<CoilCoolingDXCurveFitOperatingMode>().size());

Which the model.getConcreteModelObjects<CoilCoolingDXCurveFitOperatingMode>().size()'s value is 1.

[jmarrec]

I have access to Jenkins FYI, so I have access to the failed runs to see the failures.

The solution to having both clone to same model and clone to another is not trivial though. I'll eventually get back to this PR, it's a minor bug with a rather expensive solution: one that requires reimplementing or overriding the internals of ResourceObject and ParentObject (getRecursiveResources / getRecursiveChildren) and how things are added at Workspace level (addObjects). That portion of the sdk is complicated and finicky.
I've converted the PR to draft in the meantime for clarity.

[jmarrec]

If someone is burning to fix this though please go ahead. I think I have a jupyter notebook somewhere where I've rewritten the getRecursiveXXX stuff to be able to test changes, I could try to locate it.