Click or drag to resize

Settings Class

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:dss_sharp.Settings"]

Inheritance Hierarchy

Namespace:  dss_sharp
Assembly:  dss_sharp (in dss_sharp.dll) Version: 1.0.0
public class Settings : ContextState

The Settings type exposes the following members.

Public methodSettings
Initializes a new instance of the Settings class
Public propertyAllocationFactors
(write-only) Sets all load allocation factors for all loads defined by XFKVA property to this value.
Public propertyAllowDuplicates
{True | False*} Designates whether to allow duplicate names of objects
Public propertyAutoBusList
List of Buses or (File=xxxx) syntax for the AutoAdd solution mode.
Public propertyCktModel
{dssMultiphase (0) * | dssPositiveSeq (1) } Indicate if the circuit model is positive sequence.
Public propertyControlTrace
{True | False*} Denotes whether to trace the control actions to a file.
Public propertyEmergVmaxpu
Per Unit maximum voltage for Emergency conditions.
Public propertyEmergVminpu
Per Unit minimum voltage for Emergency conditions.
Public propertyIterateDisabled
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)
Public propertyLoadsTerminalCheck
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)
Public propertyLossRegs
Integer array defining which energy meter registers to use for computing losses
Public propertyLossWeight
Weighting factor applied to Loss register values.
Public propertyNormVmaxpu
Per Unit maximum voltage for Normal conditions.
Public propertyNormVminpu
Per Unit minimum voltage for Normal conditions.
Public propertyPriceCurve
Name of LoadShape object that serves as the source of price signal data for yearly simulations, etc.
Public propertyPriceSignal
Price Signal for the Circuit
Public propertyTrapezoidal
{True | False *} Gets value of trapezoidal integration flag in energy meters.
Public propertyUEregs
Array of Integers defining energy meter registers to use for computing UE
Public propertyUEweight
Weighting factor applied to UE register values.
Public propertyVoltageBases
Array of doubles defining the legal voltage bases in kV L-L
Public propertyZoneLock
{True | False*} Locks Zones on energy meters to prevent rebuilding if a circuit change occurs.
Protected methodCheckForError (Inherited from ContextState.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetContextHandle
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Protected fieldapiutil (Inherited from ContextState.)
Protected fieldctx (Inherited from ContextState.)
See Also