Ctrl+K

dss.IFuses

dss.IFuses#

Module Contents#

Classes#

IFuses

API#

class dss.IFuses.IFuses(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllNames: List[str]#

Array of all names of this object type

Close()#

Close all phases of the fuse.

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

property Count: int#

Number of objects of this type

property Delay: float#

A fixed delay time in seconds added to the fuse blowing time determined by the TCC curve. Default is 0. This represents a fuse clear or other delay.

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

property First: int#

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

IsBlown() → bool#

Current state of the fuses. TRUE if any fuse on any phase is blown. Else FALSE.

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

property MonitoredObj: str#

Full name of the circuit element to which the fuse is connected.

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

property MonitoredTerm: int#

Terminal number to which the fuse is connected.

Original COM help: https://opendss.epri.com/MonitoredTerm1.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: List[str]#

Array of strings indicating the normal state of each phase of the fuse.

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

property NumPhases: int#

Number of phases, this fuse.

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

Open()#

Manual opening of all phases of the fuse.

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

property RatedCurrent: float#

Multiplier or actual amps for the TCCcurve object. Defaults to 1.0.

Multiply current values of TCC curve by this to get actual amps.

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

Reset()#

Reset fuse to normal state.

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

property State: List[str]#

Array of strings indicating the state of each phase of the fuse.

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

property SwitchedObj: str#

Full name of the circuit element switch that the fuse controls. Defaults to the MonitoredObj.

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

property SwitchedTerm: int#

Number of the terminal of the controlled element containing the switch controlled by the fuse.

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

property TCCcurve: str#

Name of the TCCcurve object that determines fuse blowing.

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