dss.ISettings

`dss.ISettings`#

Module Contents#

Classes#

ISettings

API#

class dss.ISettings.ISettings(api_util, prefer_lists=False)#

Bases: dss._cffi_api_util.Base

property AllocationFactors#: (write-only) Sets all load allocation factors for all loads defined by XFKVA property to this value.

property AllowDuplicates: bool#

{True | False*} Designates whether to allow duplicate names of objects

NOTE: for DSS-Extensions, we are considering removing this option in a future release since it has performance impacts even when not used.

property AutoBusList: str#

List of Buses or (File=xxxx) syntax for the AutoAdd solution mode.

Original COM help: https://opendss.epri.com/AutoBusList.html

property CktModel: dss.enums.CktModels#

Indicate if the circuit model is positive sequence.

Original COM help: https://opendss.epri.com/CktModel.html

property ControlTrace: bool#

Denotes whether to trace the control actions to a file.

Original COM help: https://opendss.epri.com/ControlTrace.html

property EmergVmaxpu: float#

Per Unit maximum voltage for Emergency conditions.

Original COM help: https://opendss.epri.com/EmergVmaxpu.html

property EmergVminpu: float#

Per Unit minimum voltage for Emergency conditions.

Original COM help: https://opendss.epri.com/EmergVminpu.html

property IterateDisabled: int#

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)

property LoadsTerminalCheck: bool#

Controls whether the terminals are checked when updating the currents in Load component. Defaults to True. If the loads are guaranteed to have their terminals closed throughout the simulation, this can be set to False to save some time.

(API Extension)

property LossRegs: dss._types.Int32Array#

Integer array defining which energy meter registers to use for computing losses

Original COM help: https://opendss.epri.com/LossRegs.html

property LossWeight: float#

Weighting factor applied to Loss register values.

Original COM help: https://opendss.epri.com/LossWeight.html

property NormVmaxpu: float#

Per Unit maximum voltage for Normal conditions.

Original COM help: https://opendss.epri.com/NormVmaxpu.html

property NormVminpu: float#

Per Unit minimum voltage for Normal conditions.

Original COM help: https://opendss.epri.com/NormVminpu.html

property PriceCurve: str#

Name of LoadShape object that serves as the source of price signal data for yearly simulations, etc.

Original COM help: https://opendss.epri.com/PriceCurve.html

property PriceSignal: float#

Price Signal for the Circuit

Original COM help: https://opendss.epri.com/PriceSignal.html

SetPropertyNameStyle(value: dss.enums.DSSPropertyNameStyle)#

Switch the property names according to the target style.

Use this method for compatibility with code that doesn’t consider that OpenDSS is case insensitive. Check the enumeration for more: DSSPropertyNameStyle

(API Extension)

property Trapezoidal: bool#

Gets value of trapezoidal integration flag in energy meters. Defaults to False.

Original COM help: https://opendss.epri.com/Trapezoidal.html

property UEregs: dss._types.Int32Array#

Array of Integers defining energy meter registers to use for computing UE

Original COM help: https://opendss.epri.com/UEregs.html

property UEweight: float#

Weighting factor applied to UE register values.

Original COM help: https://opendss.epri.com/UEweight.html

property VoltageBases: dss._types.Float64Array#

Array of doubles defining the legal voltage bases in kV L-L