Expose Bus.LineList/LoadList, minor adjustment for lists of strings

Author: PMeira

dss/_cffi_api_util.py

@@ -148,7 +148,7 @@ def clear_buffers(self):
     def get_string(self, b):
         if b != self.ffi.NULL:
             return self.ffi.string(b).decode(self.codec)
-        return ''
+        return u''
 
     def get_float64_array(self, func, *args):
         ptr = self.ffi.new('double**')
@@ -200,7 +200,7 @@ def get_string_array(self, func, *args):
                 codec = self.codec
                 str_ptrs = self.ffi.unpack(actual_ptr, cnt[0])
                 #res = [(str(self.ffi.string(str_ptr).decode(codec)) if (str_ptr != self.ffi.NULL) else None) for str_ptr in str_ptrs]
-                res = [(self.ffi.string(str_ptr).decode(codec) if (str_ptr != self.ffi.NULL) else None) for str_ptr in str_ptrs]
+                res = [(self.ffi.string(str_ptr).decode(codec) if (str_ptr != self.ffi.NULL) else u'') for str_ptr in str_ptrs]
 
         self.lib.DSS_Dispose_PPAnsiChar(ptr, cnt[1])
         return res
@@ -219,7 +219,7 @@ def get_string_array2(self, func, *args): # for compatibility with OpenDSSDirect
             else:
                 codec = self.codec
                 res = [(str(self.ffi.string(actual_ptr[i]).decode(codec)) if (actual_ptr[i] != self.ffi.NULL) else '') for i in range(cnt[0])]
-                if res == ['']:
+                if res == [u'']:
                     # most COM methods return an empty array as an
                     # array with an empty string
                     res = []

dss/dss_capi_gr/IBus.py

@@ -222,6 +222,16 @@ def y(self):
     def y(self, Value):
         self.CheckForError(self._lib.Bus_Set_y(Value))
 
+    @property
+    def LoadList(self):
+        '''List of strings: Full Names of LOAD elements connected to the active bus.'''
+        return self.CheckForError(self._get_string_array(self._lib.Bus_Get_LoadList))
+    
+    @property
+    def LineList(self):
+        '''List of strings: Full Names of LINE elements connected to the active bus.'''
+        return self.CheckForError(self._get_string_array(self._lib.Bus_Get_LineList))
+
     def __getitem__(self, index):
         if isinstance(index, int):
             # bus index is zero based, pass it directly

dss/dss_capi_ir/IBus.py

@@ -207,6 +207,16 @@ def y(self):
     def y(self, Value):
         self.CheckForError(self._lib.Bus_Set_y(Value))
 
+    @property
+    def LoadList(self):
+        '''List of strings: Full Names of LOAD elements connected to the active bus.'''
+        return self.CheckForError(self._get_string_array(self._lib.Bus_Get_LoadList))
+    
+    @property
+    def LineList(self):
+        '''List of strings: Full Names of LINE elements connected to the active bus.'''
+        return self.CheckForError(self._get_string_array(self._lib.Bus_Get_LineList))
+
     def __getitem__(self, index):
         if isinstance(index, int):
             # bus index is zero based, pass it directly

tests/validate.py

@@ -277,6 +277,14 @@ def validate_Buses(self):
                 self.com.ActiveCircuit.SetActiveBus(name)
                 if not SAVE_COM_OUTPUT: assert A.Name == B.Name
 
+            if self.capi.ActiveCircuit.NumNodes < 1000:
+                for field in ('LoadList', 'LineList'):
+                    fB = getattr(B, field)
+                    fA = output['ActiveCircuit.ActiveBus[{}].{}'.format(name, field)] if LOAD_COM_OUTPUT else getattr(A, field)
+                    if SAVE_COM_OUTPUT: output['ActiveCircuit.ActiveBus[{}].{}'.format(name, field)] = fA
+                    if not SAVE_COM_OUTPUT: assert list(fA) == list(fB), (fA, fB)
+                    
+                
             for field in ('Coorddefined', 'Cust_Duration', 'Cust_Interrupts', 'Distance', 'Int_Duration', 'Isc', 'Lambda', 'N_Customers', 'N_interrupts', 'Nodes', 'NumNodes', 'SectionID', 'TotalMiles', 'VLL', 'VMagAngle', 'Voc', 'Voltages', 'YscMatrix', 'Zsc0', 'Zsc1', 'ZscMatrix', 'kVBase', 'puVLL', 'puVmagAngle', 'puVoltages', 'x', 'y',  'SeqVoltages', 'CplxSeqVoltages'):
                 fB = getattr(B, field)
                 if COM_VLL_BROKEN and field in ('VLL', 'puVLL') and len(fB) == 1: