 | RegControls Class |
[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:dss_sharp.RegControls"]
Inheritance HierarchyNamespace: dss_sharp
Assembly: dss_sharp (in dss_sharp.dll) Version: 1.0.0
SyntaxThe RegControls type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RegControls | Initializes a new instance of the RegControls class |
Properties| Name | Description | |
|---|---|---|
 | AllNames |
Array of strings with all RegControl names in the circuit.
|
| Count |
Number of RegControl objects in active circuit.
|
| CTPrimary |
CT primary ampere rating (secondary is 0.2 amperes)
|
| Delay |
Time delay [s] after arming before the first tap change. Control may reset before actually changing taps.
|
| First |
Sets the first RegControl active. Returns 0 if no more.
|
| ForwardBand |
Regulation bandwidth in forward direciton, centered on Vreg
|
| ForwardR |
LDC R setting in Volts
|
| ForwardVreg |
Target voltage in the forward direction, on PT secondary base.
|
| ForwardX |
LDC X setting in Volts
|
| idx |
Get/set active RegControl by index; index is 1-based: 1..count
|
| IsInverseTime |
Time delay is inversely adjsuted, proportinal to the amount of voltage outside the regulating band.
|
| IsReversible |
Regulator can use different settings in the reverse direction. Usually not applicable to substation transformers.
|
| MaxTapChange |
Maximum tap change per iteration in STATIC solution mode. 1 is more realistic, 16 is the default for a faster soluiton.
|
| MonitoredBus |
Name of a remote regulated bus, in lieu of LDC settings
|
| Name |
Sets the active RegControl by Name.
|
| Next |
Sets the next RegControl active. Returns 0 if no more.
|
| PTratio |
PT ratio for voltage control settings
|
| ReverseBand |
Bandwidth in reverse direction, centered on reverse Vreg.
|
| ReverseR |
Reverse LDC R setting in Volts.
|
| ReverseVreg |
Target voltage in the revese direction, on PT secondary base.
|
| ReverseX |
Reverse LDC X setting in volts.
|
| TapDelay |
Time delay [s] for subsequent tap changes in a set. Control may reset before actually changing taps.
|
| TapNumber |
Integer number of the tap that the controlled transformer winding is currentliy on.
|
| TapWinding |
Tapped winding number
|
| Transformer |
Name of the transformer this regulator controls
|
| VoltageLimit |
First house voltage limit on PT secondary base. Setting to 0 disables this function.
|
| Winding |
Winding number for PT and CT connections
|
Methods| Name | Description | |
|---|---|---|
 | CheckForError | (Inherited from ContextState.) |
| Equals | (Inherited from Object.) |
| Finalize | (Inherited from Object.) |
| GetContextHandle |
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| Reset | |
| ToString | (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | apiutil | (Inherited from ContextState.) |
| ctx | (Inherited from ContextState.) |
See Also