Docstrings and list of safe fields (_columns) updated; used for the latest ODD.py code generation.

Author: PMeira

dss/dss_capi_gr/IBus.py

@@ -31,7 +31,7 @@ class IBus(Base):
         'VMagAngle',
         'Voc',
         'Voltages',
-        'YscMatrix' 
+        'YscMatrix',
         'Zsc0',
         'Zsc1',
         'ZscMatrix',

dss/dss_capi_gr/ICapControls.py

@@ -21,6 +21,11 @@ class ICapControls(Iterable):
         'Vmin',
         'Vmax',
         'UseVoltOverride',
+        'Mode',
+        'MonitoredObj',
+        'MonitoredTerm',
+        'OFFSetting',
+        'ONSetting',
     ]
 
     def Reset(self):
@@ -81,7 +86,7 @@ def DelayOff(self, Value):
     @property
     def Mode(self):
         '''Type of automatic controller.'''
-        return self._lib.CapControls_Get_Mode()
+        return self._lib.CapControls_Get_Mode() #TODO: use enum
 
     @Mode.setter
     def Mode(self, Value):

dss/dss_capi_gr/ICapacitors.py

@@ -13,6 +13,7 @@ class ICapacitors(Iterable):
         'Name',
         'idx',
         'kV',
+        'NumSteps',
         'AvailableSteps',
         'IsDelta',
         'States',

dss/dss_capi_gr/ICircuit.py

@@ -104,6 +104,7 @@ class ICircuit(Base):
         'AllBusVmagPu',
         'AllBusVolts',
 
+        'AllNodeNames',
         'AllNodeDistances',
         'AllElementNames',
         'YNodeOrder',
@@ -339,7 +340,7 @@ def NumNodes(self):
 
     @property
     def ParentPDElement(self):
-        '''(read-only) Gets Parent PD element, if any, to be the active circuit element and returns index>0; Returns 0 if it fails or not applicable.'''
+        '''(read-only) Sets Parent PD element, if any, to be the active circuit element and returns index>0; Returns 0 if it fails or not applicable.'''
         return self._lib.Circuit_Get_ParentPDElement()
 
     @property

dss/dss_capi_gr/ICktElement.py

@@ -13,6 +13,7 @@ class ICktElement(Base):
     ]
 
     _columns = [
+        'Name', 
         'DisplayName',
         'Handle',
         'GUID',
@@ -22,6 +23,9 @@ class ICktElement(Base):
         'NumConductors',
         'NumControls',
         'NumProperties',
+        'AllPropertyNames', 
+        'AllVariableValues', 
+        'AllVariableNames', 
         'BusNames',
         'NormalAmps',
         'EmergAmps',
@@ -46,6 +50,7 @@ class ICktElement(Base):
         'SeqCurrents',
         'CplxSeqCurrents',
         'Residuals',
+        'Losses',
         'PhaseLosses',
     ]
 

dss/dss_capi_gr/ICtrlQueue.py

@@ -8,6 +8,14 @@
 
 class ICtrlQueue(Base):
     __slots__ = []
+    
+    _columns = [
+        'Queue', 
+        'DeviceHandle', 
+        'QueueSize', 
+        'ActionCode', 
+        'NumActions',  
+    ]
 
     def ClearActions(self):
         self._lib.CtrlQueue_ClearActions()

dss/dss_capi_gr/IDSS.py

@@ -37,6 +37,17 @@ class IDSS(Base):
         'DSSim_Coms',
         'YMatrix',
     ]
+    
+    _columns = [
+        'Version', 
+        'Classes', 
+        'NumUserClasses', 
+        'DataPath', 
+        'NumClasses', 
+        'NumCircuits', 
+        'UserClasses', 
+        'DefaultEditor',
+    ]
 
     def __init__(self, api_util):
         self.ActiveCircuit = ICircuit(api_util)
@@ -133,7 +144,8 @@ def AllowForms(self, value):
 
     @property
     def AllowEditor(self):
-        '''Gets/sets whether running the external editor for "Show" is allowed
+        '''
+        Gets/sets whether running the external editor for "Show" is allowed
         
         AllowEditor controls whether the external editor is used in commands like "Show".
         If you set to 0 (false), the editor is not executed. Note that other side effects,

dss/dss_capi_gr/IDSSElement.py

@@ -12,6 +12,12 @@ class IDSSElement(Base):
         'Properties'
     ]
 
+    _columns = [
+        'AllPropertyNames', 
+        'Name', 
+        'NumProperties',
+    ]
+    
     def __init__(self, api_util):
         self.Properties = IDSSProperty(api_util)
         Base.__init__(self, api_util)    

dss/dss_capi_gr/IDSSProperty.py

@@ -9,6 +9,12 @@
 class IDSSProperty(Base):
     __slots__ = []
 
+    _columns = [
+        'Description', 
+        'Name', 
+        'Val',
+    ]
+    
     @property
     def Description(self):
         '''(read-only) Description of the property.'''

dss/dss_capi_gr/IDSS_Executive.py

@@ -9,6 +9,11 @@
 class IDSS_Executive(Base):
     __slots__ = []
 
+    _columns = [
+        'NumCommands', 
+        'NumOptions',
+    ]
+
     def Command(self, i):
         '''(read-only) Get i-th command'''
         return self._get_string(self._lib.DSS_Executive_Get_Command(i))