Ctrl+K

dss.ILines

dss.ILines#

Module Contents#

Classes#

ILines

API#

class dss.ILines.ILines(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllNames: List[str]#

Array of all names of this object type

property Bus1: str#

Name of bus for terminal 1.

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

property Bus2: str#

Name of bus for terminal 2.

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

property C0: float#

Zero Sequence capacitance, nanofarads per unit length.

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

property C1: float#

Positive Sequence capacitance, nanofarads per unit length.

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

property Cmatrix: dss._types.Float64Array#
property Count: int#

Number of objects of this type

property EmergAmps: float#

Emergency (maximum) ampere rating of Line.

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

property First: int#

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

property Geometry: str#

Line geometry code

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

property IsSwitch: bool#

Sets/gets the Line element switch status. Setting it has side-effects to the line parameters.

(API Extension)

property Length: float#

Length of line section in units compatible with the LineCode definition.

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

property LineCode: str#

Name of LineCode object that defines the impedances.

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

property Name: str#

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

New(Name)#
property Next: int#

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

property NormAmps: float#

Normal ampere rating of Line.

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

property NumCust: int#

Number of customers on this line section.

Requires an energy meter with an updated zone.

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

property Parent: int#

Sets Parent of the active Line to be the active line. Returns 0 if no parent or action fails.

Requires an energy meter with an updated zone.

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

property Phases: int#

Number of Phases, this Line element.

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

property R0: float#

Zero Sequence resistance, ohms per unit length.

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

property R1: float#

Positive Sequence resistance, ohms per unit length.

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

property Rg: float#

Earth return resistance value used to compute line impedances at power frequency

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

property Rho: float#

Earth Resistivity, m-ohms

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

property Rmatrix: dss._types.Float64Array#

Resistance matrix (full), ohms per unit length. Array of doubles.

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

property SeasonRating: float#

Delivers the rating for the current season (in Amps) if the “SeasonalRatings” option is active

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

property Spacing: str#

Line spacing code

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

property TotalCust: int#

Total Number of customers served from this line section.

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

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

Zero Sequence reactance ohms per unit length.

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

property X1: float#

Positive Sequence reactance, ohms per unit length.

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

property Xg: float#

Earth return reactance value used to compute line impedances at power frequency

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

property Xmatrix: dss._types.Float64Array#

Reactance matrix (full), ohms per unit length. Array of doubles.

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

property Yprim: dss._types.Float64ArrayOrComplexArray#

Yprimitive for the active line object (complex array).

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