Ctrl+K

dss.IXYCurves

dss.IXYCurves#

Module Contents#

Classes#

IXYCurves

API#

class dss.IXYCurves.IXYCurves(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 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 Npts: int#

Get/Set Number of points in X-Y curve

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

property Xarray: dss._types.Float64Array#

Get/set X values as a Array of doubles. Set Npts to max number expected if setting

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

property Xscale: float#

Factor to scale X values from original curve

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

property Xshift: float#

Amount to shift X value from original curve

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

property Yarray: dss._types.Float64Array#

Get/Set Y values in curve; Set Npts to max number expected if setting

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

property Yscale: float#

Factor to scale Y values from original curve

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

property Yshift: float#

Amount to shift Y value from original curve

Original COM help: https://opendss.epri.com/Yshift.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 x: float#

Set X value or get interpolated value after setting Y

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

property y: float#

Set Y value or get interpolated Y value after setting X

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

Contents