Controller(idx: int) → str#: Full name of the i-th controller attached to this element. Ex: str = Controller(2). See NumControls to determine valid index range

property CplxSeqCurrents: dss._types.Float64ArrayOrComplexArray#

Complex double array of Sequence Currents for all conductors of all terminals of active circuit element.

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

property CplxSeqVoltages: dss._types.Float64ArrayOrComplexArray#

Complex double array of Sequence Voltage for all terminals of active circuit element.

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

property Currents: dss._types.Float64ArrayOrComplexArray#

Complex array of currents into each conductor of each terminal

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

property CurrentsMagAng: dss._types.Float64Array#

Currents in magnitude, angle (degrees) format as a array of doubles.

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

property DisplayName: str#

Display name of the object (not necessarily unique)

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

property EmergAmps: float#

Emergency Ampere Rating for PD elements

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

property Enabled: bool#

Boolean indicating that element is currently in the circuit.

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

property EnergyMeter: str#

Name of the Energy Meter this element is assigned to.

Requires an energy meter with an updated zone.

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

property GUID: str#

GUID/UUID for this object.

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

property Handle: int#

Index of this element into the circuit’s element list.

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

property HasOCPDevice: bool#

True if a recloser, relay, or fuse controlling this ckt element. OCP = Overcurrent Protection

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

property HasSwitchControl: bool#

True if this element has a SwtControl attached.

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

property HasVoltControl: bool#

True if this element has a CapControl or RegControl attached.

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

property IsIsolated: bool#

Returns true if the current active element is isolated. Note that this only fetches the current value. See also the Topology interface.

(API Extension)

IsOpen(Term: int, Phs: int) → bool#

property Losses: dss._types.Float64ArrayOrSimpleComplex#

Total losses in the element: two-element double array (complex), in VA (watts, vars)

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

property Name: str#

Full Name of Active Circuit Element

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

property NodeOrder: dss._types.Int32Array#

Array of integer containing the node numbers (representing phases, for example) for each conductor of each terminal.

Be sure to run a solution to initialize the values after the circuit is created or modified.

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

property NodeRef: dss._types.Int32Array#

Array of integers, a copy of the internal NodeRef of the CktElement.

Be sure to run a solution to initialize the values after the circuit is created or modified.

(API Extension)

property NormalAmps: float#

Normal ampere rating for PD Elements

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

property NumConductors: int#

Number of Conductors per Terminal

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

property NumControls: int#

Number of controls connected to this device. Use to determine valid range for index into Controller array.

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

property NumPhases: int#

Number of Phases

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

property NumProperties: int#

Number of Properties this Circuit Element.

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

property NumTerminals: int#

Number of terminals in this Circuit Element

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

property OCPDevIndex: int#

Index into Controller list of OCP Device controlling this CktElement

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

property OCPDevType: dss.enums.OCPDevType#

0=None; 1=Fuse; 2=Recloser; 3=Relay; Type of OCP controller device

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

Open(Term: int, Phs: int)#

Open the specified terminal and phase, if non-zero, or all conductors at the terminal.

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

property PhaseLosses: dss._types.Float64ArrayOrComplexArray#

Complex array of losses (kVA) by phase

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

property Powers: dss._types.Float64ArrayOrComplexArray#

Complex array of powers (kVA) into each conductor of each terminal

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

Properties: dss.IDSSProperty.IDSSProperty#: None

property Residuals: dss._types.Float64Array#

Residual currents for each terminal: (magnitude, angle in degrees)

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

property SeqCurrents: dss._types.Float64Array#

Double array of symmetrical component currents (magnitudes only) into each 3-phase terminal

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

property SeqPowers: dss._types.Float64ArrayOrComplexArray#

Complex array of sequence powers (kW, kvar) into each 3-phase terminal

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

property SeqVoltages: dss._types.Float64Array#

Double array of symmetrical component voltages (magnitudes only) at each 3-phase terminal

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

property TotalPowers: dss._types.Float64ArrayOrComplexArray#

Returns an array with the total powers (complex, kVA) at ALL terminals of the active circuit element.

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

Variable(MyVarName: AnyStr) → Tuple[float, int]#

Returns (value, Code). For PCElement, get the value of a variable by name. If Code>0 Then no variable by this name or not a PCelement.

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

VariableByIndex#: None

VariableByName#: None

Variablei(Idx: int) → Tuple[float, int]#

Returns (value, Code). For PCElement, get the value of a variable by integer index. If Code>0 Then no variable by this index or not a PCelement.

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

property Voltages: dss._types.Float64ArrayOrComplexArray#

Complex array of voltages at terminals

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

property VoltagesMagAng: dss._types.Float64Array#

Voltages at each conductor in magnitude, angle form as array of doubles.

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

property Yprim: dss._types.Float64ArrayOrComplexArray#

YPrim matrix, column order, complex numbers

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

__call__(index) → dss.ICktElement.ICktElement#

__getitem__(index) → dss.ICktElement.ICktElement#

__init__(api_util)#

__iter__() → Iterator[dss.ICktElement.ICktElement]#

setVariableByIndex(Idx: int, Value: float) → int#

setVariableByName(Idx: AnyStr, Value: float) → int#

dss.ICktElement

Contents

dss.ICktElement#

Module Contents#

Classes#

API#

`dss.ICktElement`#