Ctrl+K

dss.ILineCodes

dss.ILineCodes#

Module Contents#

Classes#

ILineCodes

API#

class dss.ILineCodes.ILineCodes(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllNames: List[str]#

Array of all names of this object type

property C0#

Zero-sequence capacitance, nF per unit length

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

property C1#

Positive-sequence capacitance, nF per unit length

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

property Cmatrix: dss._types.Float64Array#

Capacitance matrix, nF per unit length

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

property Count: int#

Number of objects of this type

property EmergAmps: float#

Emergency ampere rating

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

property First: int#

Sets the first object of this type active. Returns 0 if none.

property IsZ1Z0: bool#

Flag denoting whether impedance data were entered in symmetrical components

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

Normal Ampere rating

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

property Phases: int#

Number of Phases

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

property R0: float#

Zero-Sequence Resistance, ohms per unit length

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

property R1: float#

Positive-sequence resistance ohms per unit length

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

property Rmatrix: dss._types.Float64Array#

Resistance matrix, ohms per unit length

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

property Units: dss.enums.LineUnits#
property X0: float#

Zero Sequence Reactance, Ohms per unit length

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

property X1: float#

Positive-sequence reactance, ohms per unit length

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

property Xmatrix: dss._types.Float64Array#

Reactance matrix, ohms per unit length

Original COM help: https://opendss.epri.com/Xmatrix1.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)

Contents