- CheckForError: pass a result parameter to reduce boilerplate code.

- Use CheckForError in a couple more places (ICktElement and ICircuit)
- Expose DssException in v7 and v8 modules.

Author: PMeira

dss/_cffi_api_util.py

@@ -69,11 +69,14 @@ def __init__(self, api_util):
             lowercase_map = {a.lower(): a for a in cls._dss_original_attributes}
             cls._dss_attributes = lowercase_map
 
-    def CheckForError(self):
+    def CheckForError(self, result=None):
+        '''Checks for an OpenDSS error. Raises an exception if any, otherwise returns the `result` parameter.'''
         if self._errorPtr[0]:
             error_num = self._errorPtr[0]
             self._errorPtr[0] = 0
             raise DssException(error_num, self._get_string(self._lib.Error_Get_Description()))
+            
+        return result
 
     def _getattr(self, key):
         if key.startswith('_'):

dss/dss_capi_gr/ICircuit.py

@@ -208,7 +208,7 @@ def SetActiveBus(self, BusName):
         if type(BusName) is not bytes:
             BusName = BusName.encode(self._api_util.codec)
 
-        return self._lib.Circuit_SetActiveBus(BusName)
+        return self.CheckForError(self._lib.Circuit_SetActiveBus(BusName))
 
     def SetActiveBusi(self, BusIndex):
         return self._lib.Circuit_SetActiveBusi(BusIndex)
@@ -217,13 +217,13 @@ def SetActiveClass(self, ClassName):
         if type(ClassName) is not bytes:
             ClassName = ClassName.encode(self._api_util.codec)
 
-        return self._lib.Circuit_SetActiveClass(ClassName)
+        return self.CheckForError(self._lib.Circuit_SetActiveClass(ClassName))
 
     def SetActiveElement(self, FullName):
         if type(FullName) is not bytes:
             FullName = FullName.encode(self._api_util.codec)
 
-        return self._lib.Circuit_SetActiveElement(FullName)
+        return self.CheckForError(self._lib.Circuit_SetActiveElement(FullName))
 
     def UpdateStorage(self):
         self._lib.Circuit_UpdateStorage()

dss/dss_capi_gr/ICktElement.py

@@ -298,8 +298,8 @@ def __getitem__(self, index):
                 index = index.encode(self._api_util.codec)
 
             self._lib.Circuit_SetCktElementName(index)
-
-        return self
+            
+        return self.CheckForError(self)
 
     def __call__(self, index):
         return self.__getitem__(index)

dss/dss_capi_ir/ICircuit.py

@@ -205,7 +205,7 @@ def SetActiveBus(self, BusName):
         if type(BusName) is not bytes:
             BusName = BusName.encode(self._api_util.codec)
 
-        return self._lib.Circuit_SetActiveBus(BusName)
+        return self.CheckForError(self._lib.Circuit_SetActiveBus(BusName))
 
     def SetActiveBusi(self, BusIndex):
         return self._lib.Circuit_SetActiveBusi(BusIndex)
@@ -214,13 +214,13 @@ def SetActiveClass(self, ClassName):
         if type(ClassName) is not bytes:
             ClassName = ClassName.encode(self._api_util.codec)
 
-        return self._lib.Circuit_SetActiveClass(ClassName)
+        return self.CheckForError(self._lib.Circuit_SetActiveClass(ClassName))
 
     def SetActiveElement(self, FullName):
         if type(FullName) is not bytes:
             FullName = FullName.encode(self._api_util.codec)
 
-        return self._lib.Circuit_SetActiveElement(FullName)
+        return self.CheckForError(self._lib.Circuit_SetActiveElement(FullName))
 
     def UpdateStorage(self):
         self._lib.Circuit_UpdateStorage()

dss/dss_capi_ir/ICktElement.py

@@ -282,8 +282,8 @@ def __getitem__(self, index):
                 index = index.encode(self._api_util.codec)
 
             self._lib.Circuit_SetCktElementName(index)
-
-        return self
+            
+        return self.CheckForError(self)
 
     def __call__(self, index):
         return self.__getitem__(index)

dss/v7.py

@@ -4,7 +4,7 @@
 '''
 from __future__ import absolute_import
 from ._dss_capi_v7 import ffi, lib
-from ._cffi_api_util import CffiApiUtil, use_com_compat
+from ._cffi_api_util import CffiApiUtil, use_com_compat, DssException
 from . import dss_capi_gr, dss_capi_ir, enums
 from .enums import *
 

dss/v8.py

@@ -4,7 +4,7 @@
 '''
 from __future__ import absolute_import
 from ._dss_capi_v8 import ffi, lib
-from ._cffi_api_util import CffiApiUtil, use_com_compat
+from ._cffi_api_util import CffiApiUtil, use_com_compat, DssException
 from . import dss_capi_gr, dss_capi_ir, enums
 from .enums import *