Sync methods with dss_python

Author: PMeira

opendssdirect/ActiveClass.py

@@ -49,6 +49,20 @@ def ActiveClassParent():
     return get_string(CheckForError(lib.ActiveClass_Get_ActiveClassParent()))
 
 
+def ToJSON(options=0):
+    """
+    Returns the data (as a list) of all elements from the active class as a JSON-encoded string.
+
+    The `options` parameter contains bit-flags to toggle specific features.
+    See `Obj_ToJSON` (C-API) for more.
+
+    Additionally, the `ExcludeDisabled` flag can be used to excluded disabled elements from the output.
+
+    (API Extension)
+    """
+    return get_string(CheckForError(lib.ActiveClass_ToJSON(options)))
+
+
 _columns = ["ActiveClassName", "Name", "NumElements", "ActiveClassParent"]
 __all__ = [
     "ActiveClassName",
@@ -59,4 +73,5 @@ def ActiveClassParent():
     "Next",
     "NumElements",
     "ActiveClassParent",
+    "ToJSON",
 ]

opendssdirect/Basic.py

@@ -122,10 +122,12 @@ def LegacyModels(*args):
     or contact the authors from DSS Extensions: https://github.com/dss-extensions/
 
     After toggling LegacyModels, run a "clear" command and the models will be loaded accordingly.
-    Defaults to False. 
+    Defaults to False.
 
     This can also be enabled by setting the environment variable DSS_CAPI_LEGACY_MODELS to 1.
 
+    NOTE: this option will be removed in a future release.
+
     (API Extension)
     """
     # Getter
@@ -134,7 +136,31 @@ def LegacyModels(*args):
 
     # Setter
     Value, = args
-    return CheckForError(lib.DSS_Set_LegacyModels(Value))
+    CheckForError(lib.DSS_Set_LegacyModels(Value))
+
+
+def AllowChangeDir(*args):
+    """
+    If disabled, the engine will not change the active working directory during execution. E.g. a "compile"
+    command will not "chdir" to the file path.
+
+    If you have issues with long paths, enabling this might help in some scenarios.
+
+    Defaults to True (allow changes, backwards compatible) in the 0.10.x versions of DSS C-API.
+    This might change to False in future versions.
+
+    This can also be set through the environment variable DSS_CAPI_ALLOW_CHANGE_DIR. Set it to 0 to
+    disallow changing the active working directory.
+
+    (API Extension)
+    """
+    # Getter
+    if len(args) == 0:
+        return CheckForError(lib.DSS_Get_AllowChangeDir()) != 0
+
+    # Setter
+    Value, = args
+    CheckForError(lib.DSS_Set_AllowChangeDir(Value))
 
 
 _columns = [
@@ -165,4 +191,5 @@ def LegacyModels(*args):
     "NewCircuit",
     "AllowEditor",
     "LegacyModels",
+    "AllowChangeDir",
 ]

opendssdirect/Bus.py

@@ -229,6 +229,8 @@ def AllPDEatBus():
     "PuVoltage",
     "X",
     "Y",
+    "AllPCEatBus",
+    "AllPDEatBus",
 ]
 __all__ = [
     "AllPCEatBus",

opendssdirect/Circuit.py

@@ -203,7 +203,7 @@ def SystemY():
 
 
 def TotalPower():
-    """(read-only) Total power, kw delivered to the circuit"""
+    """(read-only) Total power, kW delivered to the circuit"""
     return get_float64_array(lib.Circuit_Get_TotalPower)
 
 

opendssdirect/CktElement.py

@@ -304,6 +304,23 @@ def IsIsolated():
     return CheckForError(lib.CktElement_Get_IsIsolated()) != 0
 
 
+def setVariableByIndex(Idx, Value):
+    Code = ffi.new("int32_t*")
+    CheckForError(lib.CktElement_Set_Variablei(Idx, Code, Value))
+    return Code[0]
+
+
+def setVariableByName(Idx, Value):
+    Code = ffi.new("int32_t*")
+    CheckForError(lib.CktElement_Set_Variable(Idx, Code, Value))
+    return Code[0]
+
+
+def NodeRef():
+    """Array of integers, a copy of the internal NodeRef of the CktElement."""
+    return get_int32_array(lib.CktElement_Get_NodeRef)
+
+
 _columns = [
     "BusNames",
     "CplxSeqCurrents",
@@ -392,4 +409,7 @@ def IsIsolated():
     "VoltagesMagAng",
     "YPrim",
     "IsIsolated",
+    "setVariableByIndex",
+    "setVariableByName",
+    "NodeRef",
 ]

opendssdirect/Element.py

@@ -16,5 +16,17 @@ def NumProperties():
     return CheckForError(lib.DSSElement_Get_NumProperties())
 
 
+def ToJSON(options=0):
+    """
+    Returns the properties of the active DSS object as a JSON-encoded string.
+
+    The `options` parameter contains bit-flags to toggle specific features.
+    See `Obj_ToJSON` (C-API) for more.
+
+    (API Extension)
+    """
+    return get_string(CheckForError(lib.DSSElement_ToJSON(options)))
+
+
 _columns = ["Name", "NumProperties", "AllPropertyNames"]
-__all__ = ["AllPropertyNames", "Name", "NumProperties"]
+__all__ = ["AllPropertyNames", "Name", "NumProperties", "ToJSON"]

opendssdirect/Generators.py

@@ -176,6 +176,136 @@ def kvar(*args):
     CheckForError(lib.Generators_Set_kvar(Value))
 
 
+def daily(*args):
+    """
+    Name of the loadshape for a daily generation profile.
+
+    (API Extension)
+    """
+    # Getter
+    if len(args) == 0:
+        return get_string(CheckForError(lib.Generators_Get_daily()))
+
+    # Setter
+    Value, = args
+    if type(Value) is not bytes:
+        Value = Value.encode(codec)
+    CheckForError(lib.Generators_Set_daily(Value))
+
+
+def duty(*args):
+    """
+    Name of the loadshape for a duty cycle simulation.
+
+    (API Extension)
+    """
+    # Getter
+    if len(args) == 0:
+        return get_string(CheckForError(lib.Generators_Get_duty()))
+
+    # Setter
+    Value, = args
+    if type(Value) is not bytes:
+        Value = Value.encode(codec)
+    CheckForError(lib.Generators_Set_duty(Value))
+
+
+def Yearly(*args):
+    """
+    Name of yearly loadshape
+
+    (API Extension)
+    """
+    # Getter
+    if len(args) == 0:
+        return get_string(CheckForError(lib.Generators_Get_Yearly()))
+
+    # Setter
+    Value, = args
+    if type(Value) is not bytes:
+        Value = Value.encode(codec)
+    CheckForError(lib.Generators_Set_Yearly(Value))
+
+
+def Status(*args):
+    """
+    Response to dispatch multipliers: Fixed=1 (dispatch multipliers do not apply), Variable=0 (follows curves).
+
+    Related enumeration: GeneratorStatus
+
+    (API Extension)
+    """
+    # Getter
+    if len(args) == 0:
+        return CheckForError(lib.Generators_Get_Status())
+
+    # Setter
+    Value, = args
+    CheckForError(lib.Generators_Set_Status(Value))
+
+
+def IsDelta(*args):
+    """
+    Generator connection. True/1 if delta connection, False/0 if wye.
+
+    (API Extension)
+    """
+    # Getter
+    if len(args) == 0:
+        return CheckForError(lib.Generators_Get_IsDelta()) != 0
+
+    # Setter
+    Value, = args
+    CheckForError(lib.Generators_Set_IsDelta(Value))
+
+
+def kva(*args):
+    """
+    kVA rating of electrical machine. Applied to machine or inverter definition for Dynamics mode solutions.
+
+    (API Extension)
+    """
+    # Getter
+    if len(args) == 0:
+        return CheckForError(lib.Generators_Get_kva())
+
+    # Setter
+    Value, = args
+    CheckForError(lib.Generators_Set_kva(Value))
+
+
+def Class(*args):
+    """
+    An arbitrary integer number representing the class of Generator so that Generator values may be segregated by class.
+
+    (API Extension)
+    """
+    # Getter
+    if len(args) == 0:
+        return CheckForError(lib.Generators_Get_Class_())
+
+    # Setter
+    Value, = args
+    CheckForError(lib.Generators_Set_Class_(Value))
+
+
+def Bus1(*args):
+    """
+    Bus to which the Generator is connected. May include specific node specification.
+
+    (API Extension)
+    """
+    # Getter
+    if len(args) == 0:
+        return get_string(CheckForError(lib.Generators_Get_Bus1()))
+
+    # Setter
+    Value, = args
+    if type(Value) is not bytes:
+        Value = Value.encode(codec)
+    CheckForError(lib.Generators_Set_Bus1(Value))
+
+
 _columns = [
     "ForcedON",
     "Model",
@@ -191,6 +321,14 @@ def kvar(*args):
     "kVARated",
     "kW",
     "kvar",
+    "Bus1",
+    "Class",
+    "kva",
+    "IsDelta",
+    "Status",
+    "daily",
+    "duty",
+    "Yearly",
 ]
 __all__ = [
     "AllNames",
@@ -211,4 +349,12 @@ def kvar(*args):
     "kVARated",
     "kW",
     "kvar",
+    "daily",
+    "duty",
+    "Yearly",
+    "Status",
+    "IsDelta",
+    "kva",
+    "Class",
+    "Bus1",
 ]

opendssdirect/Meters.py

@@ -269,6 +269,7 @@ def Totals():
     """(read-only) Totals of all registers of all meters"""
     return get_float64_array(lib.Meters_Get_Totals)
 
+
 def ZonePCE():
     """Returns the list of all PCE within the area covered by the energy meter"""
     return CheckForError(get_string_array(lib.Meters_Get_ZonePCE))

opendssdirect/Settings.py

@@ -35,7 +35,7 @@ def AutoBusList(*args):
 
 
 def CktModel(*args):
-    """{dssMultiphase * | dssPositiveSeq} IIndicate if the circuit model is positive sequence."""
+    """{dssMultiphase (0) * | dssPositiveSeq (1) } IIndicate if the circuit model is positive sequence."""
     # Getter
     if len(args) == 0:
         return CheckForError(lib.Settings_Get_CktModel())
@@ -222,7 +222,27 @@ def LoadsTerminalCheck(*args):
 
     # Setter
     Value, = args
-    return CheckForError(lib.Settings_Set_LoadsTerminalCheck(Value))
+    CheckForError(lib.Settings_Set_LoadsTerminalCheck(Value))
+
+
+def IterateDisabled(*args):
+    """
+    Controls whether `First`/`Next` iteration includes or skips disabled circuit elements.
+    The default behavior from OpenDSS is to skip those. The user can still activate the element by name or index.
+
+    The default value for IterateDisabled is 0, keeping the original behavior.
+    Set it to 1 (or `True`) to include disabled elements.
+    Other numeric values are reserved for other potential behaviors.
+
+    (API Extension)
+    """
+    # Getter
+    if len(args) == 0:
+        return CheckForError(lib.Settings_Get_IterateDisabled())
+
+    # Setter
+    Value, = args
+    CheckForError(lib.Settings_Set_IterateDisabled(int(Value)))
 
 
 _columns = [
@@ -243,6 +263,8 @@ def LoadsTerminalCheck(*args):
     "VoltageBases",
     "ZoneLock",
     "AllowDuplicates",
+    "LoadsTerminalCheck",
+    "IterateDisabled",
 ]
 __all__ = [
     "AllowDuplicates",
@@ -264,4 +286,5 @@ def LoadsTerminalCheck(*args):
     "ZoneLock",
     "AllocationFactors",
     "LoadsTerminalCheck",
+    "IterateDisabled",
 ]