Adds missing ActiveCircuit.CktElements[index] (or ...CktElements(index)) and ActiveCircuit.Buses[index] (or ...Buses(index)).

Author: PMeira

README.md

@@ -6,7 +6,7 @@ Python bindings and misc tools for using OpenDSS (EPRI Distribution System Simul
 
 If you are looking for the C API library, see [`dss_capi`](http://github.com/PMeira/dss_capi/).
 
-Version 0.9.4, based on [OpenDSS revision 2152](https://sourceforge.net/p/electricdss/code/2152/tree/). 
+Version 0.9.5, based on [OpenDSS revision 2152](https://sourceforge.net/p/electricdss/code/2152/tree/). 
 This is a work-in-progress but it's deemed stable enough to be made public.
 *Note that, while the interface with OpenDSS is stable (classic version), the OpenDSS-PM (actor-based parallel machine version) interface was integrated recently and is experimental.*
 
@@ -17,8 +17,9 @@ This module depends on CFFI, NumPy and, optionally, SciPy.Sparse for reading the
 
 Recent changes
 ==============
+- 2018-04-05 / version 0.9.5: Adds missing `ActiveCircuit.CktElements[index]` (or `...CktElements(index)`) and `ActiveCircuit.Buses[index]` (or `...Buses(index)`).
 - 2018-03-07 / version 0.9.4: Allows using `len` on several classes, fixes DSSProperty, and includes COM helpstrings as docstrings. Contains changes up to OpenDSS revision 2152.
-- 2018-02-16 / version 0.9.3: Integrate COM interface fixes from revision 2136 (`First` `Next` iteration on some elements)
+- 2018-02-16 / version 0.9.3: Integrates COM interface fixes from revision 2136 (`First` `Next` iteration on some elements)
 - 2018-02-12 / version 0.9.2: Experimental support for OpenDSS-PM (at the moment, a custom patch is provided for FreePascal support) and port COM interface fixes (OpenDSS revision 2134)
 - 2018-02-08 / version 0.9.1: First public release (OpenDSS revision 2123)
 

README.pdf

@@ -145,6 +145,8 @@ void Circuit_EndOfTimeStepUpdate(void);
 void Circuit_Get_YNodeOrder(char*** ResultPtr, int32_t* ResultCount);
 void Circuit_Get_YCurrents(double** ResultPtr, int32_t* ResultCount);
 void Circuit_Get_YNodeVarray(double** ResultPtr, int32_t* ResultCount);
+void Circuit_SetCktElementIndex(int32_t Value);
+void Circuit_SetCktElementName(char* Value);
 void CktElement_Get_BusNames(char*** ResultPtr, int32_t* ResultCount);
 char* CktElement_Get_Name(void);
 int32_t CktElement_Get_NumConductors(void);
@@ -1034,4 +1036,4 @@ uint16_t YMatrix_Get_UseAuxCurrents(void);
 void decompress_complex_csc_matrix(int32_t nrows, int32_t ncols, int32_t *col_ptrs, int32_t *col_indices, double* complex_vals, double* complex_output);
 void dss_custom_update_loads(int *idx, double *kw, size_t count);
 void dss_custom_enable_loads(int *idx, int enabled, size_t count);
-void dss_custom_line_currents(double *line_norm_amps, int *line_nodes, double* Ia, double* Ib, double* Ic, double* In);
+void dss_custom_line_currents(double *line_norm_amps, int *line_nodes, double* Ia, double* Ib, double* Ic, double* In);

cffi/dss_capi_cffi.h

@@ -145,6 +145,8 @@ void Circuit_EndOfTimeStepUpdate(void);
 void Circuit_Get_YNodeOrder(char*** ResultPtr, int32_t* ResultCount);
 void Circuit_Get_YCurrents(double** ResultPtr, int32_t* ResultCount);
 void Circuit_Get_YNodeVarray(double** ResultPtr, int32_t* ResultCount);
+void Circuit_SetCktElementIndex(int32_t Value);
+void Circuit_SetCktElementName(char* Value);
 void CktElement_Get_BusNames(char*** ResultPtr, int32_t* ResultCount);
 char* CktElement_Get_Name(void);
 int32_t CktElement_Get_NumConductors(void);

cffi/dsspm_capi_cffi.h

@@ -7,4 +7,4 @@
 from .enums import *
 from . import enums
 
-__version__ = '0.9.4'
+__version__ = '0.9.5'

dss/__init__.py

@@ -251,6 +251,23 @@ def y(self):
     def y(self, Value):
         lib.Bus_Set_y(Value)
 
+    def __getitem__(self, index):
+        if isinstance(index, int):
+            # bus index is zero based, pass it directly
+            lib.Circuit_SetActiveBusi(index)
+        else:
+            if type(index) is not bytes:
+                index = index.encode(codec)
+                
+            lib.Circuit_SetActiveBus(index)
+    
+        return self
+        
+    def __call__(self, index):
+        return self.__getitem__(index)
+        
+
+
 
 class ICapacitors(FrozenClass):
     _isfrozen = freeze
@@ -4959,6 +4976,23 @@ def Yprim(self):
         '''(read-only) YPrim matrix, column order, complex numbers (paired)'''
         return get_float64_array(lib.CktElement_Get_Yprim)
 
+    def __getitem__(self, index):
+        if isinstance(index, int):
+            # index is zero based, pass it directly
+            lib.Circuit_SetCktElementIndex(index)
+        else:
+            if type(index) is not bytes:
+                index = index.encode(codec)
+                
+            lib.Circuit_SetCktElementName(index)
+    
+        return self
+        
+    def __call__(self, index):
+        return self.__getitem__(index)
+        
+
+
 
 class IDSSElement(FrozenClass):
     _isfrozen = freeze

dss/dss_capi.py

@@ -7,4 +7,4 @@
 from ..enums import *
 from .. import enums
 
-__version__ = '0.9.4'
+__version__ = '0.9.5'

dss/pm/__init__.py

@@ -251,6 +251,23 @@ def y(self):
     def y(self, Value):
         lib.Bus_Set_y(Value)
 
+    def __getitem__(self, index):
+        if isinstance(index, int):
+            # bus index is zero based, pass it directly
+            lib.Circuit_SetActiveBusi(index)
+        else:
+            if type(index) is not bytes:
+                index = index.encode(codec)
+                
+            lib.Circuit_SetActiveBus(index)
+    
+        return self
+        
+    def __call__(self, index):
+        return self.__getitem__(index)
+        
+
+
 
 class ICapacitors(FrozenClass):
     _isfrozen = freeze
@@ -5045,6 +5062,23 @@ def Yprim(self):
         '''(read-only) YPrim matrix, column order, complex numbers (paired)'''
         return get_float64_array(lib.CktElement_Get_Yprim)
 
+    def __getitem__(self, index):
+        if isinstance(index, int):
+            # index is zero based, pass it directly
+            lib.Circuit_SetCktElementIndex(index)
+        else:
+            if type(index) is not bytes:
+                index = index.encode(codec)
+                
+            lib.Circuit_SetCktElementName(index)
+    
+        return self
+        
+    def __call__(self, index):
+        return self.__getitem__(index)
+        
+
+
 
 class IDSSElement(FrozenClass):
     _isfrozen = freeze

dss/pm/dsspm_capi.py

@@ -151,9 +151,9 @@ def validate_CktElement(self):
         all_props = list(A.AllPropertyNames)
         for prop_name in all_props:
             is_equal = False
-            if A.Properties(prop_name).val != B.Properties(prop_name).val:
-                val_A = A.Properties(prop_name).val
-                val_B = B.Properties(prop_name).val
+            if A.Properties(prop_name).Val != B.Properties(prop_name).Val:
+                val_A = A.Properties(prop_name).Val
+                val_B = B.Properties(prop_name).Val
                 # Try as floats
                 try:
                     val_A = float(val_A)
@@ -164,8 +164,8 @@ def validate_CktElement(self):
                     val_B = 1
 
                 if val_A != val_B:
-                    val_A = A.Properties(prop_name).val
-                    val_B = B.Properties(prop_name).val
+                    val_A = A.Properties(prop_name).Val
+                    val_B = B.Properties(prop_name).Val
 
                     # Try as matrices of floats                    
                     if val_A.startswith('[') and val_A.endswith(']'):
@@ -179,18 +179,29 @@ def validate_CktElement(self):
                                     break
 
 
-                if not (is_equal or val_A == val_B or A.Properties(prop_name).val == B.Properties(prop_name).val):
-                    print('ERROR: CktElement.Properties({}).val'.format(prop_name), A.Properties(prop_name).val, B.Properties(prop_name).val)
+                if not (is_equal or val_A == val_B or A.Properties(prop_name).Val == B.Properties(prop_name).Val):
+                    print('ERROR: CktElement.Properties({}).Val'.format(prop_name), A.Properties(prop_name).Val, B.Properties(prop_name).Val)
 
-            assert (A.Properties(prop_name).description == B.Properties(prop_name).description), ('Properties({}).description'.format(prop_name), A.Properties(prop_name).description, B.Properties(prop_name).description)
+            assert (A.Properties(prop_name).Description == B.Properties(prop_name).Description), ('Properties({}).Description'.format(prop_name), A.Properties(prop_name).Description, B.Properties(prop_name).Description)
             assert (A.Properties(prop_name).name == B.Properties(prop_name).name), ('Properties({}).name'.format(prop_name), A.Properties(prop_name).name, B.Properties(prop_name).name)
 
-            assert (B.Properties(prop_name).val == B.Properties[prop_name].val)
-            assert (B.Properties(prop_name).description == B.Properties[prop_name].description)
+            assert (B.Properties(prop_name).Val == B.Properties[prop_name].Val)
+            assert (B.Properties(prop_name).Description == B.Properties[prop_name].Description)
             assert (B.Properties(prop_name).name == B.Properties[prop_name].name)
 
 
     def validate_Buses(self):
+        for idx in range(len(self.AllBusNames)):
+            A = self.com.ActiveCircuit.Buses(idx)
+            B = self.capi.ActiveCircuit.Buses(idx)
+            assert A.Name == B.Name
+            
+        for name in self.AllBusNames[-1]:
+            A = self.com.ActiveCircuit.Buses(name)
+            B = self.capi.ActiveCircuit.Buses(name)
+            assert A.Name == B.Name
+
+            
         A = self.com.ActiveCircuit.ActiveBus
         B = self.capi.ActiveCircuit.ActiveBus
         for name in self.AllBusNames[-1]:
@@ -693,6 +704,37 @@ def validate_Circuit(self):
             "YNodeVarray" : self.YNodeVarray,
         }
 
+        # Get all line names
+        lines_names = []
+        LA = self.com.ActiveCircuit.Lines
+        nA = LA.First
+        while nA != 0:
+            lines_names.append(LA.Name)
+            nA = LA.Next
+            
+        # Test Circuit_SetCktElementName with line names
+        for name in lines_names:
+            A = self.capi.ActiveCircuit.CktElements('Line.' + name)
+            B = self.com.ActiveCircuit.CktElements('Line.' + name)
+            assert A.Name == B.Name
+            
+        # Test Circuit_SetCktElementIndex
+        for idx in range(len(self.AllBusNames[-1])):
+            # Note: idx is not the bus index but it is a valid CktElement index 
+            A = self.capi.ActiveCircuit.CktElements(idx)
+            B = self.com.ActiveCircuit.CktElements(idx)
+            assert A.Name == B.Name
+
+        # Try to use an invalid index
+        A = self.capi.ActiveCircuit.CktElements(999999)
+        B = self.com.ActiveCircuit.CktElements(999999)
+        assert A.Name == B.Name
+
+        # Try to use an invalid name
+        A = self.capi.ActiveCircuit.CktElements('NONEXISTENT_123456789')
+        B = self.com.ActiveCircuit.CktElements('NONEXISTENT_123456789')
+        assert A.Name == B.Name
+        
         for k, v in all_fields.items():
             if type(v[1]) == np.ndarray:
                 print(k, max(abs(v[1] - v[0])))
@@ -755,6 +797,7 @@ def run_tests(fns):
 
     import win32com.client
     com = win32com.client.Dispatch("OpenDSSEngine.DSS")
+    #com = win32com.client.gencache.EnsureDispatch("OpenDSSEngine.DSS")
 
     #import comtypes.client
     #com = comtypes.client.CreateObject("OpenDSSEngine.DSS")
@@ -783,12 +826,11 @@ def run_tests(fns):
 
 if __name__ == '__main__':
     fns = [
-        
+        "../../electricdss/Distrib/IEEETestCases/IEEE 30 Bus/Master.dss",
         "../../electricdss/Distrib/EPRITestCircuits/ckt5/Master_ckt5.dss",
          "../../electricdss/Distrib/EPRITestCircuits/ckt7/Master_ckt7.dss",
          "../../electricdss/Distrib/EPRITestCircuits/ckt24/Master_ckt24.dss",
         "../../electricdss/Distrib/IEEETestCases/8500-Node/Master-unbal.dss",
-        "../../electricdss/Distrib/IEEETestCases/IEEE 30 Bus/Master.dss",
         "../../electricdss/Distrib/IEEETestCases/NEVTestCase/NEVMASTER.DSS",
         "../../electricdss/Distrib/IEEETestCases/37Bus/ieee37.dss",
         "../../electricdss/Distrib/IEEETestCases/4Bus-DY-Bal/4Bus-DY-Bal.DSS",
@@ -840,4 +882,7 @@ def run_tests(fns):
 
     ]
 
-    run_tests(fns)
+    from time import time
+    t0_global = time()
+    run_tests(fns)
+    print(time() - t0_global, 'seconds')