Ctrl+K

dss.ILineGeometries

dss.ILineGeometries#

Module Contents#

Classes#

ILineGeometries

LineGeometry objects

API#

class dss.ILineGeometries.ILineGeometries(api_util)#

Bases: dss._cffi_api_util.Iterable

LineGeometry objects

(API Extension)

property AllNames: List[str]#

Array of all names of this object type

Cmatrix(Frequency: float, Length: float, Units: int) → dss._types.Float64Array#

Capacitance matrix, nF

property Conductors: List[str]#

Array of strings with names of all conductors in the active LineGeometry object

property Count: int#

Number of objects of this type

property EmergAmps: float#

Emergency ampere rating

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 Nconds: int#

Number of conductors in this geometry. Default is 3. Triggers memory allocations. Define first!

property Next: int#

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

property NormAmps: float#

Normal ampere rating

property Phases: int#

Number of Phases

property Reduce: bool#
property RhoEarth: float#
Rmatrix(Frequency: float, Length: float, Units: int) → dss._types.Float64Array#

Resistance matrix, ohms

property Units: List[dss.enums.LineUnits]#
property Xcoords: dss._types.Float64Array#

Get/Set the X (horizontal) coordinates of the conductors

Xmatrix(Frequency: float, Length: float, Units: int) → dss._types.Float64Array#

Reactance matrix, ohms

property Ycoords: dss._types.Float64Array#

Get/Set the Y (vertical/height) coordinates of the conductors

Zmatrix(Frequency: float, Length: float, Units: int) → dss._types.Float64ArrayOrComplexArray#

Complex impedance matrix, ohms

__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)

Contents