BusBatch: Add missing Name function.

Author: PMeira

altdss/Bus.py

@@ -1,6 +1,6 @@
 # Copyright (c) 2023-2024 Paulo Meira
 # Copyright (c) 2023-2024 DSS-Extensions contributors
-from typing import Union, Iterator
+from typing import Union, Iterator, List
 from dss.enums import DSSJSONFlags
 from .types import Float64Array, Int32Array, ComplexArray
 from .common import Base, InvalidatedBus
@@ -417,17 +417,29 @@ def to_json(self, options: Union[int, DSSJSONFlags] = 0):
 
 
 class BusBatch(Base):
+    def _unpack(self):
+        ptr, cnt = self._get_ptr_cnt()
+        if cnt == 0:
+            return []
+
+        return self._api_util.ffi.unpack(ptr, cnt)
+
     def ZSCRefresh(self) -> bool:
         '''
         Refreshes the Zsc matrix for all buses in the batch
         '''
-        ptrList, cnt = self._get_ptr_cnt()
         res = True
-        for n in range(cnt):
-            res = res and (self._lib.Alt_Bus_ZscRefresh(ptrList[n]) != 0)
+        for ptr in self._unpack():
+            res = res and (self._lib.Alt_Bus_ZscRefresh(ptr) != 0)
 
         return res
 
+    def Name(self) -> List[str]:
+        '''
+        Array of strings containing names of all buses in circuit.
+        '''
+        return [self._get_string(self._lib.Alt_Bus_Get_Name(ptr)) for ptr in self._unpack()]
+
     def _busbatch_float64(self, fname: str):
         return self._get_float64_array(
             self._lib.Alt_BusBatch_GetFloat64FromFunc, 
@@ -515,9 +527,8 @@ def __len__(self) -> int:
         return self._cnt
 
     def __iter__(self) -> Iterator[Bus]:
-        ptrList, cnt = self._get_ptr_cnt()
-        for n in range(cnt):
-            yield Bus(self._api_util, ptrList[n])
+        for ptr in self._unpack():
+            yield Bus(self._api_util, ptr)
 
     def to_json(self, options: Union[int, DSSJSONFlags] = 0):
         '''
@@ -560,3 +571,8 @@ def find(self, index_or_name: Union[int, str]) -> Bus:
         '''
         return self[index_or_name]
 
+    def Name(self) -> List[str]:
+        '''
+        Array of strings containing names of all buses in circuit.
+        '''
+        return self._check_for_error(self._get_string_array(self._lib.Circuit_Get_AllBusNames))

altdss/PDElement.py

@@ -240,6 +240,16 @@ def TotalMiles(self) -> Float64Array:
         '''
         return self._get_batch_float64_func("Alt_PDE_Get_TotalMiles")
 
+    def TotalKilometers(self) -> Float64Array:
+        '''
+        Total kilometers of line from this element to the end of the zone. For recloser siting algorithm.
+        
+        *Requires a previous call to `RelCalc` command*
+
+        Original COM help: https://opendss.epri.com/TotalMiles1.html
+        '''
+        return self._get_batch_float64_func("Alt_PDE_Get_TotalMiles") * 1.609344
+
     def SectionID(self) -> Int32Array:
         '''
         Integer ID of the feeder section that each PDElement branch in this batch is part of.

docs/changelog.md

@@ -6,11 +6,11 @@ relevant. See [DSS C-API's repository](https://github.com/dss-extensions/dss_cap
 ## 0.2.2
 
 - SystemY: in `AltDSS.SystemY`, return the matrix as a SciPy sparse matrix directly.
+- BusBatch: Add missing `Name` function (the bus names were already exposed in the individual objects and at circuit level in `AltDSS.BusNames`).
 - CircuitElement/CircuitElementBatch: Complement doc strings; fix some type hints.
 - CircuitElementBatch: 
     - Fix `MaxCurrent`. This will require the backend to be updated to v0.14.3.
     - Implement `OCPDevice`
-
 - NonUniformBatch: allow `batch[idx]` to get a single element by index.
 - Setters: 
     - Allow using `None` to clear object references (e.g. `altdss.Load[0].Daily = None`)