Ctrl+K

dss.IReclosers

dss.IReclosers#

Module Contents#

Classes#

IReclosers

API#

class dss.IReclosers.IReclosers(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllNames: List[str]#

Array of all names of this object type

Close()#
property Count: int#

Number of objects of this type

property First: int#

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

property GroundInst: float#

Ground (3I0) instantaneous trip setting - curve multiplier or actual amps.

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

property GroundTrip: float#

Ground (3I0) trip multiplier or actual amps

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

property MonitoredObj: str#

Full name of object this Recloser to be monitored.

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

property MonitoredTerm: int#

Terminal number of Monitored object for the Recloser

Original COM help: https://opendss.epri.com/MonitoredTerm2.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 NormalState: int#

Get/set normal state (ActionCodes.Open=1, ActionCodes.Close=2) of the recloser.

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

property NumFast: int#

Number of fast shots

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

Open()#
property PhaseInst: float#

Phase instantaneous curve multiplier or actual amps

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

property PhaseTrip: float#

Phase trip curve multiplier or actual amps

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

property RecloseIntervals: dss._types.Float64Array#

Array of Doubles: reclose intervals, s, between shots.

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

Reset()#

Reset recloser to normal state. If open, lock out the recloser. If closed, resets recloser to first operation.

property Shots: int#

Number of shots to lockout (fast + delayed)

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

property State: int#

Get/Set present state of recloser. If set to open (ActionCodes.Open=1), open recloser’s controlled element and lock out the recloser. If set to close (ActionCodes.Close=2), close recloser’s controlled element and resets recloser to first operation.

property SwitchedObj: str#

Full name of the circuit element that is being switched by the Recloser.

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

property SwitchedTerm: int#

Terminal number of the controlled device being switched by the Recloser

Original COM help: https://opendss.epri.com/SwitchedTerm1.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