Ctrl+K

dss.IRegControls

dss.IRegControls#

Module Contents#

Classes#

IRegControls

API#

class dss.IRegControls.IRegControls(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllNames: List[str]#

Array of all names of this object type

property CTPrimary: float#

CT primary ampere rating (secondary is 0.2 amperes)

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

property Count: int#

Number of objects of this type

property Delay: float#

Time delay [s] after arming before the first tap change. Control may reset before actually changing taps.

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

property First: int#

Sets the first object of this type active. Returns 0 if none.

property ForwardBand: float#

Regulation bandwidth in forward direction, centered on Vreg

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

property ForwardR: float#

LDC R setting in Volts

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

property ForwardVreg: float#

Target voltage in the forward direction, on PT secondary base.

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

property ForwardX: float#

LDC X setting in Volts

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

property IsInverseTime: bool#

Time delay is inversely adjusted, proportional to the amount of voltage outside the regulating band.

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

property IsReversible: bool#

Regulator can use different settings in the reverse direction. Usually not applicable to substation transformers.

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

property MaxTapChange: int#

Maximum tap change per iteration in STATIC solution mode. 1 is more realistic, 16 is the default for a faster solution.

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

property MonitoredBus: str#

Name of a remote regulated bus, in lieu of LDC settings

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

property Name: str#

Gets the current name or sets the active object of this type by name

property Next: int#

Sets next object of this type active. Returns 0 if no more.

property PTratio: float#

PT ratio for voltage control settings

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

Reset()#
property ReverseBand: float#

Bandwidth in reverse direction, centered on reverse Vreg.

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

property ReverseR: float#

Reverse LDC R setting in Volts.

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

property ReverseVreg: float#

Target voltage in the revese direction, on PT secondary base.

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

property ReverseX: float#

Reverse LDC X setting in volts.

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

property TapDelay: float#

Time delay [s] for subsequent tap changes in a set. Control may reset before actually changing taps.

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

property TapNumber: int#

Integer number of the tap that the controlled transformer winding is currently on.

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

property TapWinding: int#

Tapped winding number

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

property Transformer: str#

Name of the transformer this regulator controls

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

property VoltageLimit: float#

First house voltage limit on PT secondary base. Setting to 0 disables this function.

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

property Winding: int#

Winding number for PT and CT connections

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

__init__(api_util)#
__iter__() → Iterator[dss._cffi_api_util.Iterable]#

Get an iterator of the object collection.

Note that OpenDSS, via the classic APIs, only allow a single object of a specific type to be activated. That is, you cannot use references of distinct objects and interact with both at the same time, or keep a reference to use later. You need to reactivate the target object or ensure it is the active one.

For an alternative, consider using our AltDSS-Python package.

(API Extension)

__len__() → int#
property idx: int#

Gets the current index or sets the active object of this type by index

While the official API included this for some classes, this is an API Extension for:

  • Capacitors

  • CapControls

  • ISources

  • LineCodes

  • Lines

  • LoadShapes

  • Meters

  • Monitors

  • RegControls

  • Sensors

  • SwtControls

  • Transformers

  • Vsources

  • XYCurves

(API Extension)

Contents