Module Contents#




class dss.ICapacitors.ICapacitors(api_util)#

Bases: dss._cffi_api_util.Iterable

AddStep() bool#
property AllNames: List[str]#

Array of all names of this object type

property AvailableSteps: int#

Number of Steps available in cap bank to be switched ON.

Original COM help: https://opendss.epri.com/AvailableSteps.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 IsDelta: bool#

Delta connection or wye?

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

Number of steps (default 1) for distributing and switching the total bank kVAR.

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

property States: dss._types.Int32Array#

An array of integers [0..NumSteps-1] indicating state of each step. If the read value is -1 an error has occurred.

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

SubtractStep() bool#
__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 kV: float#

Bank kV rating. Use LL for 2 or 3 phases, or actual can rating for 1 phase.

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

property kvar: float#

Total bank KVAR, distributed equally among phases and steps.