def solution_write_total_time(self, argument) -> float:
"""Sets the accumulated time (microseconds) register. The new value for this register must be specified in
the argument. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.SolutionF(ctypes.c_int32(26),
ctypes.c_double(argument)))
def regcontrols_write_delay(self, argument) -> float:
"""Sets the time delay [s] after arming before the first tap change. Control may reset before actually
changing taps. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.RegControlsF(ctypes.c_int32(13),
ctypes.c_double(argument)))
def transformers_write_xlt(self, argument) -> float:
"""Sets the percent reactance between windings 2 and 3, on winding 1 kVA base. Use for 3 winding transformers
only. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.TransformersF(ctypes.c_int32(21),
ctypes.c_double(argument)))
def loads_write_pct_std_dev(self, argument) -> float:
"""Allows to write the PctStdDev property of the active load. The parameter argument must contain the new
value in PctStdDev for the desired active load. The return value will be equal to 0. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.DSSLoadsF(ctypes.c_int32(11),
ctypes.c_double(argument)))
def regcontrols_write_tap_delay(self, argument) -> float:
"""Sets the time delay [s] for subsequent tap changes in a set. Control may reset before actually changing
taps."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.RegControlsF(ctypes.c_int32(15),
ctypes.c_double(argument)))
def loads_write_vmin_pu(self, argument) -> float:
"""Allows to write the VMinpu property of the active load. The parameter argument must contain the new value
in VMinpu for the desired active load. The return value will be equal to 0. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.DSSLoadsF(ctypes.c_int32(35),
ctypes.c_double(argument)))
def loads_write_cvr_vars(self, argument) -> float:
"""Allows to write the CVRvars property of the active load. The parameter argument must contain the new value
in CVRWatts for the desired active load. The return value will be equal to 0. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.DSSLoadsF(ctypes.c_int32(19),
ctypes.c_double(argument)))
def loads_write_allocation_factor(self, argument) -> float:
"""Allows to write the AllocationFactor property of the active load. The parameter argument must contain the
new value in AllocationFactor for the desired active load. The return value will be equal to 0. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.DSSLoadsF(ctypes.c_int32(13),
ctypes.c_double(argument)))
def linecodes_write_c0(self, argument: float) -> float:
"""Sets the Zero-sequence capacitance in ohms per unit length for the active LineCode.
This value must be specified in the argument as a double."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.LineCodesF(ctypes.c_int32(11),
ctypes.c_double(argument)))
def linecodes_write_emerg_amps(self, argument: float) -> float:
"""Sets the Emergency ampere rating for the active LineCode. This value must be specified in the argument
as a double."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.LineCodesF(ctypes.c_int32(15),
ctypes.c_double(argument)))
def pdelements_write_pct_permanent(self, argument) -> float:
"""Sets the percent of faults that are permanent (require repair). Otherwise, fault is assumed to be
transient/temporary. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.PDElementsF(ctypes.c_int32(3),
ctypes.c_double(argument)))
def transformers_write_kva(self, argument) -> float:
"""Sets the active winding kVA rating. On winding 1, this also determines normal and emergency current
ratings for all windings. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.TransformersF(ctypes.c_int32(11),
ctypes.c_double(argument)))
def loads_write_rel_weight(self, argument) -> float:
"""Allows to write the RelWeight (relative weighting factor) property of the active load. The parameter
argument must contain the new value in RelWeight for the desired active load. The return value will be equal
to 0. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.DSSLoadsF(ctypes.c_int32(43),
ctypes.c_double(argument)))
def loads_write_pct_series_rl(self, argument) -> float:
"""allows to write the PctSeriesRL (Percent of Load that is modeled as series R-L for harmonic studies)
property of the active load. The parameter argument must contain the new value in PctSeriesRL for the desired
active load. The return value will be equal to 0. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.DSSLoadsF(ctypes.c_int32(41),
ctypes.c_double(argument)))
def loads_write_xfkva(self, argument) -> float:
"""Allows to write the xfKVA (Rated service transformer KVA for load allocation, using Allocationfactor.
Affects kW, kvar and pf.) property of the active load. The parameter argument must contain the new value in
xfKVA for the desired active load. The return value will be equal to 0. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.DSSLoadsF(ctypes.c_int32(37),
ctypes.c_double(argument)))
def loads_write_r_neut(self, argument) -> float:
"""Allows to write the RNeut (neutral resistance for wye connected loads) property of the active load. The
parameter argument must contain the new value in RNeut for the desired active load. The return value will be
equal to 0. """
argument = Base.check_float_param(argument)
return float(
self.dss_obj.DSSLoadsF(ctypes.c_int32(27),
ctypes.c_double(argument)))
def bus_write_y(self, param_coordinate: float) -> int:
"""Allows to write the Y coordinate for the bus. Returns 0.
:param param_coordinate: The Y coordinate, if it's None, Y will be 0.0
"""
param_coordinate = Base.check_float_param(param_coordinate)
result = self.dss_obj.BUSF(4, ctypes.c_double(param_coordinate))
Base.check_assertion_result(
result, "Write Y coordinate failed!",
"Something wrong when tried defined the Y "
"coordinate!")
return result
def generators_write_kva_rated(self, argument: float) -> float:
"""Sets the KVA rating of the generator."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.GeneratorsF(ctypes.c_int32(9),
ctypes.c_double(argument)))
def generators_write_vmin_pu(self, argument: float) -> float:
"""Sets the Vminpu for Generator Model."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.GeneratorsF(ctypes.c_int32(13),
ctypes.c_double(argument)))
def generators_write_kvar(self, argument: float) -> float:
"""Sets the kvar output for the active generator, kW is updated for current power factor."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.GeneratorsF(ctypes.c_int32(5),
ctypes.c_double(argument)))
def generators_write_pf(self, argument: float) -> float:
"""Sets the power factor (pos. = producing vars). Updates kvar based on present kW value."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.GeneratorsF(ctypes.c_int32(7),
ctypes.c_double(argument)))
def sensors_write_weight(self, argument) -> float:
"""Sets the weighting factor for this sensor measurement with respect to the other sensors. Default is 1."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.SensorsF(ctypes.c_int32(3),
ctypes.c_double(argument)))
def generators_write_kv(self, argument: float) -> float:
"""Sets the voltage base for the active generator, kV."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.GeneratorsF(ctypes.c_int32(1),
ctypes.c_double(argument)))
def write_y_scale(self, argument) -> float:
"""Sets the factor to scale Y values from original curve."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.XYCurvesF(ctypes.c_int32(11),
ctypes.c_double(argument)))
def pdelements_write_fault_rate(self, argument) -> float:
"""Sets the number of failures per year. For LINE elements: Number of failures per unit length per year."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.PDElementsF(ctypes.c_int32(1),
ctypes.c_double(argument)))
def write_y_shift(self, argument) -> float:
"""Sets the amount to shift Y value from original curve."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.XYCurvesF(ctypes.c_int32(7),
ctypes.c_double(argument)))
def write_y(self, argument) -> float:
"""Sets the Y value."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.XYCurvesF(ctypes.c_int32(3),
ctypes.c_double(argument)))
def capacitors_write_kvar(self, argument: float):
"""Sets the total bank kvar, distributed equally among phases and steps."""
# TODO: what is the the return type?
argument = Base.check_float_param(argument)
return self.dss_obj.CapacitorsF(3, ctypes.c_double(argument))
def capacitors_write_kv(self, argument: float):
"""Sets the bank rating. Use LL for 2 or 3 phases, or actual can rating for 1 phase."""
# TODO: what is the the return type?
argument = Base.check_float_param(argument)
return self.dss_obj.CapacitorsF(1, ctypes.c_double(argument))
def sensors_write_kv_base(self, argument) -> float:
"""Sets the voltage base for the sensor measurements. LL for 2 and 3 - phase sensors, LN for 1-phase sensors."""
argument = Base.check_float_param(argument)
return float(
self.dss_obj.SensorsF(ctypes.c_int32(5),
ctypes.c_double(argument)))
