altdss.CircuitElement

Module Contents

Classes

CircuitElementBatch	Non-uniform batch of circuit elements. Can contain distinct types, while providing common functions
CircuitElementBatchMixin
CircuitElementMixin
ElementHasRegistersMixin

API

class altdss.CircuitElement.CircuitElementBatch(func, parent, sync_cls_idx=ExtraClassIDs.CktElements, copy_safe=False)

Bases: altdss.Batch.NonUniformBatch, altdss.CircuitElement.CircuitElementBatchMixin

Non-uniform batch of circuit elements. Can contain distinct types, while providing common functions

ComplexSeqCurrents() → altdss.types.ComplexArray

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

ComplexSeqVoltages() → altdss.types.ComplexArray

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

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

Currents() → altdss.types.ComplexArray

Complex array of currents into each conductor of each terminal

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

CurrentsMagAng() → altdss.types.Float64Array

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

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

FullName() → List[str]

Returns the full name (including object type) for all objects in this batch

GUID() → List[str]

GUID/UUID for each object. Currently used only in the CIM-related methods.

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

Handle() → altdss.types.Int32Array

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

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

HasOCPDevice() → altdss.types.BoolArray

For each element in the batch: returns true if a recloser, relay, or fuse controlling the circuit element.

OCP = Overcurrent Protection

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

HasSwitchControl() → altdss.types.BoolArray

For each element in the batch: returns true if the element has a SwtControl attached.

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

HasVoltControl() → altdss.types.BoolArray

For each element in the batch: returns true if the element has a CapControl or RegControl attached.

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

IsIsolated() → altdss.types.BoolArray

For each element in the batch: returns true if the element is isolated. Note that this only fetches the current value. See also the Topology interface.

Losses() → altdss.types.ComplexArray

For each element in the batch: total losses in the element, in VA (watts, vars).

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

MaxCurrent(terminal: int) → altdss.types.Float64Array

Returns the maximum current (magnitude) at the specified terminal for each element in this batch. Use -1 as terminal to get the value across all terminals.

property Name: List[str]

NumConductors() → altdss.types.Int32Array

Number of conductors per terminal for each element in the batch.

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

NumControllers() → altdss.types.Int32Array

Number of controllers connected to each device in the batch.

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

NumPhases() → altdss.types.Int32Array

Number of Phases for each element in this batch.

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

NumTerminals() → altdss.types.Int32Array

Number of terminals for each Circuit Element in the batch.

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

OCPDevice() → List[Union[altdss.DSSObj.DSSObj, None]]

Returns (as a list of Python objects) the OCP device controlling each element.

OCPDeviceIndex() → altdss.types.Int32Array

For each element in the batch: index into each controller list of the OCP Device controlling each circuit element

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

OCPDeviceType() → List[dss.enums.OCPDevType]

For each element in the batch: type of OCP controller device

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

PhaseLosses() → altdss.types.ComplexArray

Complex array of losses (kVA) by phase

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

Powers() → altdss.types.ComplexArray

Complex array of powers (kVA) into each conductor of each terminal, of each element in the batch.

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

SeqCurrents() → altdss.types.Float64Array

Array of symmetrical component currents (magnitudes only) into each 3-phase terminal of each element

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

SeqPowers() → altdss.types.ComplexArray

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

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

SeqVoltages() → altdss.types.Float64Array

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

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

TotalPowers() → altdss.types.ComplexArray

Returns an array with the total powers (complex, kVA) at all terminals of the circuit elements in this batch.

The resulting array is equivalent to concatenating the TotalPowers for each element.

Voltages() → altdss.types.ComplexArray

Complex array of voltages at terminals

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

VoltagesMagAng() → altdss.types.Float64Array

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

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

__call__()

__getitem__(idx: int) → altdss.DSSObj.DSSObj

Return an object of the batch by index (0-based).

__init__(func, parent, sync_cls_idx=ExtraClassIDs.CktElements, copy_safe=False)

__iter__() → Iterator[altdss.DSSObj.DSSObj]

__len__() → int

to_json(options: Union[int, dss.enums.DSSJSONFlags] = 0)

Returns the data (as a list) of the elements in a batch as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features. See Obj_ToJSON (C-API) for more, or DSSObj.to_json in Python.

Additionally, the ExcludeDisabled flag can be used to excluded disabled elements from the output.

to_list()

class altdss.CircuitElement.CircuitElementBatchMixin

ComplexSeqCurrents() → altdss.types.ComplexArray

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

ComplexSeqVoltages() → altdss.types.ComplexArray

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

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

Currents() → altdss.types.ComplexArray

Complex array of currents into each conductor of each terminal

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

CurrentsMagAng() → altdss.types.Float64Array

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

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

GUID() → List[str]

GUID/UUID for each object. Currently used only in the CIM-related methods.

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

Handle() → altdss.types.Int32Array

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

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

HasOCPDevice() → altdss.types.BoolArray

For each element in the batch: returns true if a recloser, relay, or fuse controlling the circuit element.

OCP = Overcurrent Protection

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

HasSwitchControl() → altdss.types.BoolArray

For each element in the batch: returns true if the element has a SwtControl attached.

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

HasVoltControl() → altdss.types.BoolArray

For each element in the batch: returns true if the element has a CapControl or RegControl attached.

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

IsIsolated() → altdss.types.BoolArray

For each element in the batch: returns true if the element is isolated. Note that this only fetches the current value. See also the Topology interface.

Losses() → altdss.types.ComplexArray

For each element in the batch: total losses in the element, in VA (watts, vars).

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

MaxCurrent(terminal: int) → altdss.types.Float64Array

Returns the maximum current (magnitude) at the specified terminal for each element in this batch. Use -1 as terminal to get the value across all terminals.

NumConductors() → altdss.types.Int32Array

Number of conductors per terminal for each element in the batch.

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

NumControllers() → altdss.types.Int32Array

Number of controllers connected to each device in the batch.

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

NumPhases() → altdss.types.Int32Array

Number of Phases for each element in this batch.

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

NumTerminals() → altdss.types.Int32Array

Number of terminals for each Circuit Element in the batch.

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

OCPDevice() → List[Union[altdss.DSSObj.DSSObj, None]]

Returns (as a list of Python objects) the OCP device controlling each element.

OCPDeviceIndex() → altdss.types.Int32Array

For each element in the batch: index into each controller list of the OCP Device controlling each circuit element

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

OCPDeviceType() → List[dss.enums.OCPDevType]

For each element in the batch: type of OCP controller device

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

PhaseLosses() → altdss.types.ComplexArray

Complex array of losses (kVA) by phase

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

Powers() → altdss.types.ComplexArray

Complex array of powers (kVA) into each conductor of each terminal, of each element in the batch.

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

SeqCurrents() → altdss.types.Float64Array

Array of symmetrical component currents (magnitudes only) into each 3-phase terminal of each element

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

SeqPowers() → altdss.types.ComplexArray

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

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

SeqVoltages() → altdss.types.Float64Array

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

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

TotalPowers() → altdss.types.ComplexArray

Returns an array with the total powers (complex, kVA) at all terminals of the circuit elements in this batch.

The resulting array is equivalent to concatenating the TotalPowers for each element.

Voltages() → altdss.types.ComplexArray

Complex array of voltages at terminals

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

VoltagesMagAng() → altdss.types.Float64Array

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

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

class altdss.CircuitElement.CircuitElementMixin(*args)

Close(terminal: int, phase: int) → None

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

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

ComplexSeqCurrents() → altdss.types.ComplexArray

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

ComplexSeqVoltages() → altdss.types.ComplexArray

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

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

Controllers

‘NonUniformBatch(…)’

Controllers attached to this element.

Currents() → altdss.types.ComplexArray

Complex array of currents into each conductor of each terminal

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

DisplayName: str

‘property(…)’

Display name of the object (not necessarily unique)

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

GUID() → str

Object’s GUID/UUID. Currently used only in the CIM-related methods.

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

Handle() → int

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

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

HasOCPDevice() → bool

Returns true if a recloser, relay, or fuse controlling the circuit element.

OCP = Overcurrent Protection

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

HasSwitchControl() → bool

Returns true if the element has a SwtControl attached.

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

HasVoltControl() → bool

Returns true if the element has a CapControl or RegControl attached.

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

IsIsolated() → bool

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

IsOpen(terminal: int, phase: int) → bool

Returns true if the specified terminal and phase are open.

If the phase parameter is zero, returns if any conductor at the terminal is open.

Losses() → complex

Total (complex) losses in the element, in VA (watts, vars)

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

MaxCurrent(terminal: int) → float

Returns the maximum current (magnitude) at the specified terminal. Use -1 as terminal to get the value across all terminals.

NodeOrder() → altdss.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.

NodeRef() → altdss.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.

NumConductors() → int

Number of conductors per terminal

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

NumControllers() → int

Number of controllers connected to this device.

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

NumPhases() → int

Number of phases

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

NumTerminals() → int

Number of terminals in this circuit element

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

OCPDevice() → Union[altdss.DSSObj.DSSObj, None]

Returns (as a Python object) the OCP device controlling this element, if any.

OCPDeviceIndex() → int

Index into controller list of OCP Device controlling this circuit element

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

OCPDeviceType() → dss.enums.OCPDevType

Type of OCP controller device

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

Open(terminal: int, phase: int) → None

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

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

PhaseLosses() → altdss.types.ComplexArray

Complex array of losses (kVA) by phase

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

Powers() → altdss.types.ComplexArray

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

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

Residuals() → altdss.types.Float64Array

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

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

SeqCurrents() → altdss.types.Float64Array

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

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

SeqPowers() → altdss.types.ComplexArray

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

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

SeqVoltages() → altdss.types.Float64Array

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

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

TotalPowers() → altdss.types.ComplexArray

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

Voltages() → altdss.types.ComplexArray

Complex array of voltages at terminals

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

VoltagesMagAng() → altdss.types.Float64Array

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

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

YPrim() → altdss.types.ComplexArray

YPrim matrix, column order, complex numbers

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

__init__(*args)

class altdss.CircuitElement.ElementHasRegistersMixin

RegisterNames() → List[str]

List of names of the energy meter registers for this element.

See also the enums EnergyMeterRegisters and GeneratorRegisters.

RegisterValues() → altdss.types.Float64Array

Array of values in this element’s energy meter registers.

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

RegistersDict() → Dict[str, float]

Convenience function: returns a dict of the element’s energy meter register names mapping to their current values.