Ctrl+K

dss.ILoadShapes

dss.ILoadShapes#

Module Contents#

Classes#

ILoadShapes

API#

class dss.ILoadShapes.ILoadShapes(api_util)#

Bases: dss._cffi_api_util.Iterable

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

Fixed interval time value, in hours.

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

property MinInterval: float#

Fixed Interval time value, in minutes

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

property Name: str#

Gets the current name or sets the active object of this type by name

New(Name: AnyStr)#

Create a new LoadShape, with default parameters

property Next: int#

Sets next object of this type active. Returns 0 if no more.

Normalize()#

Normalize the LoadShape data inplace

property Npts: int#

Get/set Number of points in active Loadshape.

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

property PBase: float#

Base P value for normalization. Default is zero, meaning the peak will be used.

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

Pbase#

None

property Pmult: dss._types.Float64Array#

Array of doubles for the P multiplier in the Loadshape.

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

property QBase: float#

Base for normalizing Q curve. If left at zero, the peak value is used.

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

Qbase#

None

property Qmult: dss._types.Float64Array#

Array of doubles containing the Q multipliers.

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

SInterval#

None

Sinterval#

None

property TimeArray: dss._types.Float64Array#

Time array in hours corresponding to P and Q multipliers when the Interval=0.

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

property UseActual: bool#

Boolean flag to let Loads know to use the actual value in the curve rather than use the value as a multiplier.

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

UseFloat32()#

Converts the current LoadShape data to float32/single precision. If there is no data or the data is already represented using float32, nothing is done.

(API Extension)

UseFloat64()#

Converts the current LoadShape data to float64/double precision. If there is no data or the data is already represented using float64, nothing is done.

(API Extension)

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

Fixed interval time value, in seconds.

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

Contents