Closed jmarrec closed 1 year ago
Another issue I found: this returns 0, not -1 when not found: https://github.com/NREL/EnergyPlus/blob/af674b952fea904d4d0bb3af11166583e4444e37/src/EnergyPlus/api/datatransfer.cc#L820-L832
This conflicts with the public docstring (python) here: https://github.com/NREL/EnergyPlus/blob/af674b952fea904d4d0bb3af11166583e4444e37/src/EnergyPlus/api/datatransfer.py#L608-L616
and it's unlike the other getXXX methods
Issue overview
in C/C++:
apiDataFullyReady
does the exact oppositehttps://github.com/NREL/EnergyPlus/blob/af674b952fea904d4d0bb3af11166583e4444e37/src/EnergyPlus/api/datatransfer.cc#L125-L132
This leads to horrendous things to read like this comment: https://github.com/NREL/EnergyPlus/blob/af674b952fea904d4d0bb3af11166583e4444e37/tst/EnergyPlus/unit/api/datatransfer.unit.cc#L321
This also means that in this test, we actually NEVER get past this point and read the handles (the test does nothing):
https://github.com/NREL/EnergyPlus/blob/af674b952fea904d4d0bb3af11166583e4444e37/tst/EnergyPlus/api/TestDataTransfer.c#L64
The same code is in the I/O ref: https://github.com/NREL/EnergyPlus/blob/af674b952fea904d4d0bb3af11166583e4444e37/doc/input-output-reference/src/overview/api-usage.tex#L283
I suggest flipping the return, so that int can be converted to a bool properly
Details
Some additional details for this issue (if relevant):
Checklist
Add to this list or remove from it as applicable. This is a simple templated set of guidelines.