Skip to content

Commit 3d3fde4

Browse files
committed
Transformers: add a warning in the docstrings of WdgCurrents, WdgVoltages.
1 parent 9489e0c commit 3d3fde4

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

dss/ITransformers.py

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,19 +190,34 @@ def kVA(self, Value: float):
190190

191191
@property
192192
def WdgVoltages(self) -> Float64ArrayOrComplexArray:
193-
'''Complex array of voltages for active winding'''
193+
'''
194+
Complex array of voltages for active winding
195+
196+
WARNING: If the transformer has open terminal(s), results may be wrong, i.e. avoid using this
197+
in those situations. For more information, see https://github.com/dss-extensions/dss-extensions/issues/24
198+
'''
194199
self.CheckForError(self._lib.Transformers_Get_WdgVoltages_GR())
195200
return self._get_complex128_gr_array()
196201

197202
@property
198203
def WdgCurrents(self) -> Float64ArrayOrComplexArray:
199-
'''All Winding currents (ph1, wdg1, wdg2,... ph2, wdg1, wdg2 ...)'''
204+
'''
205+
All Winding currents (ph1, wdg1, wdg2,... ph2, wdg1, wdg2 ...)
206+
207+
WARNING: If the transformer has open terminal(s), results may be wrong, i.e. avoid using this
208+
in those situations. For more information, see https://github.com/dss-extensions/dss-extensions/issues/24
209+
'''
200210
self.CheckForError(self._lib.Transformers_Get_WdgCurrents_GR())
201211
return self._get_complex128_gr_array()
202212

203213
@property
204214
def strWdgCurrents(self) -> str:
205-
'''All winding currents in CSV string form like the WdgCurrents property'''
215+
'''
216+
All winding currents in CSV string form like the WdgCurrents property
217+
218+
WARNING: If the transformer has open terminal(s), results may be wrong, i.e. avoid using this
219+
in those situations. For more information, see https://github.com/dss-extensions/dss-extensions/issues/24
220+
'''
206221
return self._get_string(self.CheckForError(self._lib.Transformers_Get_strWdgCurrents()))
207222

208223
@property

0 commit comments

Comments
 (0)