def circuit_all_node_vmag_pu_by_phase(self,
argument: int = 1) -> List[float]:
"""Returns array of doubles representing the voltage magnitudes (in per unit) for nodes on the specified phase.
The phase must be specified in the Argument2."""
argument = Base.check_int_param(argument,
default=1) # Phase 1 as default
return Bridge.VarArrayFunction(self.dss_obj.CircuitV, 15, argument, '')
def cap_controls_all_names(self) -> List[str]:
result = Bridge.VarArrayFunction(self.dss_obj.CapControlsV, 0, None,
'')
if result == -1:
raise ValueError(
"An error ocurred when tries to READ CapControls states! ")
return result
def circuit_all_node_distances_by_phase(self,
argument: int = 1) -> List[float]:
"""Returns array of doubles representing the distances to parent EnergyMeter. Sequence of array corresponds to
other node ByPhase properties. Argument2 must contain the number of the phase to return."""
argument = Base.check_int_param(argument,
default=1) # Phase 1 as default
return Bridge.VarArrayFunction(self.dss_obj.CircuitV, 16, argument, '')
def capacitors_read_states(self) -> List[int]:
"""Gets a variant array of integers [0..numsteps-1] indicating the state of each step.
If value is -1 and error has occurred."""
result = Bridge.VarArrayFunction(self.dss_obj.CapacitorsV, 1, None, '')
if result == -1:
raise ValueError(
"An error ocurred when tries to READ Capacitors states! ")
return result
def relays_all_names(self):
"""Getsa variant array of strings containing names of all relay elements."""
return Bridge.VarArrayFunction(self.dss_obj.RelaysV, ctypes.c_int(0),
ctypes.c_int(0), None)
def loadshapes_read_q_mult(self):
"""Gets a variant array of doubles for the Q multiplier in the LoadShape."""
return Bridge.VarArrayFunction(self.dss_obj.LoadShapeV, 3, None, '')
def loads_read_zipv(self):
"""Allows to read the array of 7 elements (doubles) for ZIP property of the active Load object."""
return Bridge.VarArrayFunction(self.dss_obj.DSSLoadsV, 1, None, '')
def transformers_wdg_currents(self):
"""Gets a a variant array of doubles containing the currents at the active winding on the active transformer.
These currents come as complex pairs."""
return Bridge.VarArrayFunction(self.dss_obj.TransformersV, ctypes.c_int(2), ctypes.c_int(0), None)
def dss_user_classes(self) -> List[str]:
"""Gets list of user-defined classes (names of the classes)."""
return Bridge.VarArrayFunction(self.dss_obj.DSSV, 1, None, '')
def generators_register_values(self) -> List[float]:
"""Gets the array of values in generator Energy Meter registers."""
return Bridge.VarArrayFunction(self.dss_obj.GeneratorsV, 2, None, '')
def bus_vmag_angle(self):
"""Returns a variant array of doubles containing voltages in magnitude (VLN), angle (deg)."""
return Bridge.VarArrayFunction(self.dss_obj.BUSV, 13, None, '')
def bus_pu_vll(self):
"""Returns a variant array of complex numbers representing L-L voltages in per unit. Returns -1.0 for 1-phase
bus. If more than 3 phases, returns only first 3.. """
return Bridge.VarArrayFunction(self.dss_obj.BUSV, 12, None, '')
def bus_sequence_voltages(self):
"""Returns the complex double array of sequence voltages (0, 1, 2) at this bus."""
return Bridge.VarArrayFunction(self.dss_obj.BUSV, 10, None, '')
def bus_ysc_matrix(self):
"""Returns the complex array of Ysc matrix at bus, column by column."""
return Bridge.VarArrayFunction(self.dss_obj.BUSV, 9, None, '')
def bus_zsc0(self):
"""Returns the complex zero-sequence short circuit impedance at bus."""
return Bridge.VarArrayFunction(self.dss_obj.BUSV, 8, None, '')
def generators_all_names(self) -> List[str]:
"""Gets the array of names of all Generator objects."""
return Bridge.VarArrayFunction(self.dss_obj.GeneratorsV, 0, None, '')
def generators_register_names(self) -> List[str]:
"""Gets the array of names of all generator Energy Meter registers."""
return Bridge.VarArrayFunction(self.dss_obj.GeneratorsV, 1, None, '')
def bus_pu_vmag_angle(self):
"""Returns a variant array of doubles containing voltages in per unit and angles in degrees."""
return Bridge.VarArrayFunction(self.dss_obj.BUSV, 14, None, '')
def dss_classes(self) -> List[str]:
"""Gets the list of DSS intrinsic classes (names of the classes)."""
return Bridge.VarArrayFunction(self.dss_obj.DSSV, 0, None, '')
def bus_load_list(self):
"""This parameter returns a variant array of strings containing the names of the loads connected to the
active bus. The names of the lines include the class name 'Load.'. """
return Bridge.VarArrayFunction(self.dss_obj.BUSV, 16, None, '')
def transformers_all_Names(self):
"""Gets a variant array of strings with all Transformer names in the active circuit."""
return Bridge.VarArrayFunction(self.dss_obj.TransformersV, ctypes.c_int(0), ctypes.c_int(0), None)
def bus_axc_012_matrix(self):
"""Variant array of doubles (complex) containing the complete 012 Zsc matrix."""
return Bridge.VarArrayFunction(self.dss_obj.BUSV, 17, None, '')
def loads_all_names(self):
"""Allows to read the names of all the loads present in the active circuit. The result is delivered as
variant, however, the content of this variant is an array of strings. """
return Bridge.VarArrayFunction(self.dss_obj.DSSLoadsV, 0, None, '')
def bus_all_pce_active_bus(self) -> List[str]:
"""Returns an array with the names of all PCE connected to the active bus."""
return Bridge.VarArrayFunction(self.dss_obj.BUSV, 18, None, '')
def loadshapes_all_names(self):
"""Gets a variant array of strings containing names of all LoadShape objects currently defined."""
return Bridge.VarArrayFunction(self.dss_obj.LoadShapeV, 0, None, '')
def parser_vector(self):
"""Returns token as variant array of doubles. For parsing quoted array syntax."""
return Bridge.VarArrayFunction(self.dss_obj.ParserV, ctypes.c_int(0),
ctypes.c_int(0), None)
def loadshapes_read_time_array(self):
"""Gets a time array in hours corresponding to P and Q multipliers when the Interval = 0."""
return Bridge.VarArrayFunction(self.dss_obj.LoadShapeV,
ctypes.c_int(5), ctypes.c_int(0), None)
def parser_matrix(self):
"""Use this property to parse a Matrix token in OpenDSS format. Returns square matrix of order specified.
Order same as default fortran order: column by column. """
return Bridge.VarArrayFunction(self.dss_obj.ParserV, ctypes.c_int(1),
ctypes.c_int(0), None)
def isources_all_names(self) -> List[str]:
"""Gets the variant array of string containing names of all ISources in the circuit."""
return Bridge.VarArrayFunction(self.dss_obj.IsourceV, 0, None, '')
def parser_sym_matrix(self):
"""Use this property to parse a Matrix token in lower triangular form. Symmetry is forced."""
return Bridge.VarArrayFunction(self.dss_obj.ParserV, ctypes.c_int(2),
ctypes.c_int(0), None)