Ctrl+K

dss.IVsources

dss.IVsources#

Module Contents#

Classes#

IVsources

API#

class dss.IVsources.IVsources(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllNames: List[str]#

Array of all names of this object type

property AngleDeg: float#

Phase angle of first phase in degrees

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

property BasekV: float#

Source voltage in kV

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

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 Frequency: float#

Source frequency in Hz

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

Number of phases

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

property pu: float#

Per-unit value of source voltage

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

Contents