Skip to content

Commit 7c1d16e

Browse files
committed
CktElement: add note that VariableNames/Values are only valid for PCElements.
Users will be able to toggle between the current exception and the previous empty list in the next release (by disabling ExtendedErrors, etc.).
1 parent fb55068 commit 7c1d16e

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

opendssdirect/CktElement.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,18 @@ def AllPropertyNames():
7474

7575

7676
def AllVariableNames():
77-
"""(read-only) Array of strings listing all the published variable names, if a PCElement. Otherwise, null string."""
77+
"""
78+
Array of strings listing all the published state variable names.
79+
Valid only for PCElements.
80+
"""
7881
return CheckForError(get_string_array(lib.CktElement_Get_AllVariableNames))
7982

8083

8184
def AllVariableValues():
82-
"""(read-only) Array of doubles. Values of state variables of active element if PC element."""
85+
"""
86+
Array of doubles. Values of state variables of active element if PC element.
87+
Valid only for PCElements.
88+
"""
8389
return CheckForError(get_float64_array(lib.CktElement_Get_AllVariableValues))
8490

8591

0 commit comments

Comments
 (0)