Ctrl+K

dss.IStorages

dss.IStorages#

Module Contents#

Classes#

IStorages

Storage objects

API#

class dss.IStorages.IStorages(api_util)#

Bases: dss._cffi_api_util.Iterable

Storage objects

property AllNames: List[str]#

Array of all names of this object type

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 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 RegisterNames: List[str]#

Array of Storage energy meter register names

See also the enum GeneratorRegisters.

property RegisterValues: dss._types.Float64Array#

Array of values in Storage registers.

property State: dss.enums.StorageStates#

Get/set state: 0=Idling; 1=Discharging; -1=Charging;

__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 puSOC: float#

Per unit state of charge

Contents