Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Fix #4543 - E+ 22.1.0: Wrap SetpointManager:SystemNodeReset:Temperature and SetpointManager:SystemNodeReset:Humidity #4619

Merged
merged 14 commits into from
Jun 29, 2022
Merged

Fix #4543 - E+ 22.1.0: Wrap SetpointManager:SystemNodeReset:Temperature and SetpointManager:SystemNodeReset:Humidity #4619

merged 14 commits into from
Jun 29, 2022

Conversation

jmarrec
Copy link
Collaborator

@jmarrec jmarrec commented Jun 27, 2022 •
edited
Loading

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: Fix #4543 - E+ 22.1.0: Wrap SetpointManager:SystemNodeReset:Temperature and SetpointManager:SystemNodeReset:Humidity OpenStudio-resources#170
  • 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 added 13 commits June 27, 2022 13:39
@jmarrec
Add E+ IDD without modifications
58a1a11
@jmarrec
#4543 - Add handle, make small modifications
f923e73
@jmarrec
Modernize generateclass.rb to use using instead of typedef
c5f33aa
@jmarrec
Use generateclass.rb to stub files
2db06b9 
```shell
$os_build2/Products/openstudio GenerateClass.rb -c "SetpointManagerSystemNodeResetTemperature" -b "SetpointManager"  -i "OS:SetpointManager:SystemNodeReset:Temperature" -s model -o $os_model2/ -p -f -r

$os_build2/Products/openstudio GenerateClass.rb -c "SetpointManagerSystemNodeResetHumidity" -b "SetpointManager"  -i "OS:SetpointManager:SystemNodeReset:Humidity" -s model -o $os_model2 -p -f -r
```
@jmarrec
Register new objects
f8eb20d
@jmarrec
Modify headers to conform to the SetpointManager (base class) API
a6a70ee
@jmarrec
Modify SPM:SystemNodeReset:Humidity: allow only on AirLoopHVAC nodes
1b862c4
@jmarrec
Modify SPM:SNR:Temperature: allow on both AirLoopHVAC and PlantLoops
aef4956
@jmarrec
Write tests for the two new SPMs
1223f06
@jmarrec
Register FT
15944d2
@jmarrec
Write the FT: do not translate if missing the setpoint or reference n…
e1e927d 
…odes
@jmarrec
Write FT tests
96ad578
@jmarrec
Write the ReverseTranslator, but do not activate them.
99c003d
@jmarrec jmarrec added Enhancement Request component - HVAC component - Model Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. labels Jun 27, 2022
@jmarrec jmarrec self-assigned this Jun 27, 2022
jmarrec added a commit to NREL/OpenStudio-resources that referenced this pull request Jun 27, 2022
@jmarrec
Add a test for NREL/OpenStudio#4543
cbcecf3 
companion PR: NREL/OpenStudio#4619
@jmarrec jmarrec mentioned this pull request Jun 27, 2022
Merged
23 tasks
@jmarrec jmarrec requested a review from joseph-robertson June 28, 2022 15:43
@jmarrec
Copy link
Collaborator Author

jmarrec commented Jun 28, 2022

The windows build failure has nothing to do with this PR. We need to wipe the build directory again... a process left a csharp wrap file open probably.

joseph-robertson
joseph-robertson reviewed Jun 28, 2022
View reviewed changes
Copy link
Collaborator

@joseph-robertson joseph-robertson left a comment

Choose a reason for hiding this comment

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

Looks good. I mostly just have a few minor questions/thoughts. The two objects look very similar, so assume that any questions for the first also apply to the second.

src/energyplus/ReverseTranslator.cpp
@@ -810,6 +810,14 @@ namespace energyplus {
//modelObject = translateSetpointManagerSingleZoneReheat(workspaceObject);
break;
}
case openstudio::IddObjectType::SetpointManager_SystemNodeReset_Humidity: {
//modelObject = translateSetpointManagerSystemNodeResetHumidity(workspaceObject);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh, you are just stubbing these?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Until we invest into the effort of ReverseTranslating Loops (which we don't currently), I must leave it disabled yes

src/model/SetpointManagerSystemNodeResetHumidity.cpp
// From E+ 5ZoneSystemNodeReset.idf (22.1.0)
bool ok = setControlVariable("MaximumHumidityRatio");
OS_ASSERT(ok);
setSetpointatLowReferenceHumidityRatio(0.00924);
Copy link
Collaborator

Choose a reason for hiding this comment

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

OS_ASSERT(ok) on all of these set methods?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah I don't think that's needed here. I'm setting positive, non zero, numeric values. That's never going to change. The Choice field could change and I could forget to update the Ctor though.

@ci-commercialbuildings
Copy link
Collaborator

ci-commercialbuildings commented Jun 29, 2022 •
edited
Loading

CI Results for daa5369:

@jmarrec jmarrec merged commit 0e7dda7 into develop Jun 29, 2022
@jmarrec jmarrec deleted the 4543_New_SPMs branch June 29, 2022 07:40
@jmarrec jmarrec mentioned this pull request Oct 17, 2022
Merged
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@joseph-robertson joseph-robertson joseph-robertson left review comments

Assignees

@jmarrec jmarrec

Labels
component - HVAC component - Model Enhancement Request 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.

E+ 22.1.0: Wrap SetpointManager:SystemNodeReset:Temperature and SetpointManager:SystemNodeReset:Humidity
3 participants
@jmarrec @ci-commercialbuildings @joseph-robertson