Settings Properties |
[This is preliminary documentation and is subject to change.]
The Settings type exposes the following members.
Name | Description | |
---|---|---|
AllocationFactors |
(write-only) Sets all load allocation factors for all loads defined by XFKVA property to this value.
| |
AllowDuplicates |
{True | False*} Designates whether to allow duplicate names of objects
| |
AutoBusList |
List of Buses or (File=xxxx) syntax for the AutoAdd solution mode.
| |
CktModel |
{dssMultiphase (0) * | dssPositiveSeq (1) } Indicate if the circuit model is positive sequence.
| |
ControlTrace |
{True | False*} Denotes whether to trace the control actions to a file.
| |
EmergVmaxpu |
Per Unit maximum voltage for Emergency conditions.
| |
EmergVminpu |
Per Unit minimum voltage for Emergency conditions.
| |
IterateDisabled |
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)
| |
LoadsTerminalCheck |
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)
| |
LossRegs |
Integer array defining which energy meter registers to use for computing losses
| |
LossWeight |
Weighting factor applied to Loss register values.
| |
NormVmaxpu |
Per Unit maximum voltage for Normal conditions.
| |
NormVminpu |
Per Unit minimum voltage for Normal conditions.
| |
PriceCurve |
Name of LoadShape object that serves as the source of price signal data for yearly simulations, etc.
| |
PriceSignal |
Price Signal for the Circuit
| |
Trapezoidal |
{True | False *} Gets value of trapezoidal integration flag in energy meters.
| |
UEregs |
Array of Integers defining energy meter registers to use for computing UE
| |
UEweight |
Weighting factor applied to UE register values.
| |
VoltageBases |
Array of doubles defining the legal voltage bases in kV L-L
| |
ZoneLock |
{True | False*} Locks Zones on energy meters to prevent rebuilding if a circuit change occurs.
|