altdss.Line

class altdss.Line.ILine(iobj)#

Bases: altdss.DSSObj.IDSSObj, altdss.Line.LineBatch

AccumulatedL() → altdss.types.Float64Array#

Accumulated failure rate for the branch on downline, for each branch in this batch.

Requires a previous call to RelCalc command

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

B0: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Alternate way to specify C0. MicroS per unit length

DSS property name: B0, DSS property index: 27.

B1: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Alternate way to specify C1. MicroS per unit length

DSS property name: B1, DSS property index: 26.

BaseFreq: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Base Frequency for ratings.

DSS property name: BaseFreq, DSS property index: 36.

Bus1: List[str]#

‘property(…)’

Name of bus to which first terminal is connected. Example: bus1=busname (assumes all terminals connected in normal phase order) bus1=busname.3.1.2.0 (specify terminal to node connections explicitly)

DSS property name: Bus1, DSS property index: 1.

Bus2: List[str]#

‘property(…)’

Name of bus to which 2nd terminal is connected.

DSS property name: Bus2, DSS property index: 2.

C0: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Zero-sequence capacitance, nf per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.See also B0.

DSS property name: C0, DSS property index: 11.

C1: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Positive-sequence capacitance, nf per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Cmatrix and B1.

DSS property name: C1, DSS property index: 10.

CMatrix: List[altdss.types.Float64Array]#

‘property(…)’

Nodal Capacitance matrix, lower triangle, nf per unit length.Order of the matrix is the number of phases. May be used to specify the shunt capacitance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: CMatrix, DSS property index: 14.

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

Conductors: List[List[Union[altdss.WireData.WireData, altdss.CNData.CNData, altdss.TSData.TSData]]]#

‘property(…)’

Array of WireData names for use in an overhead line constants calculation. Must be used in conjunction with the Spacing property. Specify the Spacing first, and “ncond” wires. May also be used to specify bare neutrals with cables, using “ncond-nphase” wires.

DSS property name: Wires, DSS property index: 22.

Conductors_str: List[List[str]]#

‘property(…)’

Array of WireData names for use in an overhead line constants calculation. Must be used in conjunction with the Spacing property. Specify the Spacing first, and “ncond” wires. May also be used to specify bare neutrals with cables, using “ncond-nphase” wires.

DSS property name: Wires, DSS property index: 22.

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

EarthModel: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

One of {Carson | FullCarson | Deri}. Default is the global value established with the Set EarthModel command. See the Options Help on EarthModel option. This is used to override the global value for this line. This option applies only when the “geometry” property is used.

DSS property name: EarthModel, DSS property index: 23.

EarthModel_str: List[str]#

‘property(…)’

One of {Carson | FullCarson | Deri}. Default is the global value established with the Set EarthModel command. See the Options Help on EarthModel option. This is used to override the global value for this line. This option applies only when the “geometry” property is used.

DSS property name: EarthModel, DSS property index: 23.

EmergAmps: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Maximum or emerg current.

DSS property name: EmergAmps, DSS property index: 32.

Enabled: List[bool]#

‘property(…)’

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: Enabled, DSS property index: 37.

EnergyMeter() → List[Optional[altdss.DSSObj.DSSObj]]#

Return the energy meter for each of the elements in this batch.

Requires an energy meter with an updated zone.

EnergyMeterName() → List[str]#

Return the energy meter name for each of the elements in this batch.

Requires an energy meter with an updated zone.

FaultRate: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Failure rate PER UNIT LENGTH per year. Length must be same units as LENGTH property. Default is 0.1 fault per unit length per year.

DSS property name: FaultRate, DSS property index: 33.

FromTerminal() → altdss.types.Int32Array#

Number of the terminal of each PD element of this batch that is on the “from” side.

Requires an energy meter with an updated zone.

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

Geometry: List[altdss.LineGeometry.LineGeometry]#

‘property(…)’

Geometry code for LineGeometry Object. Supersedes any previous definition of line impedance. Line constants are computed for each frequency change or rho change. CAUTION: may alter number of phases. You cannot subsequently change the number of phases unless you change how the line impedance is defined.

DSS property name: Geometry, DSS property index: 19.

Geometry_str: List[str]#

‘property(…)’

Geometry code for LineGeometry Object. Supersedes any previous definition of line impedance. Line constants are computed for each frequency change or rho change. CAUTION: may alter number of phases. You cannot subsequently change the number of phases unless you change how the line impedance is defined.

DSS property name: Geometry, DSS property index: 19.

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.

IsShunt() → List[bool]#

Indicates if each of the PD elements in the batch should be treated as a shunt element rather than a series element.

Applies to Capacitor, Reactor, Fault and GICTransformer elements.

Lambda() → altdss.types.Float64Array#

Failure rate for each of the branches in the batch. Faults per year including length of line.

Requires a previous call to RelCalc command

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

Length: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Length of line. Default is 1.0. If units do not match the impedance data, specify “units” property.

DSS property name: Length, DSS property index: 4.

Like(value: AnyStr, flags: altdss.enums.SetterFlags = 0)#

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: Like, DSS property index: 38.

LineCode: List[altdss.LineCode.LineCode]#

‘property(…)’

Name of linecode object describing line impedances. If you use a line code, you do not need to specify the impedances here. The line code must have been PREVIOUSLY defined. The values specified last will prevail over those specified earlier (left-to-right sequence of properties). You can subsequently change the number of phases if symmetrical component quantities are specified.If no line code or impedance data are specified, the line object defaults to 336 MCM ACSR on 4 ft spacing.

DSS property name: LineCode, DSS property index: 3.

LineCode_str: List[str]#

‘property(…)’

Name of linecode object describing line impedances. If you use a line code, you do not need to specify the impedances here. The line code must have been PREVIOUSLY defined. The values specified last will prevail over those specified earlier (left-to-right sequence of properties). You can subsequently change the number of phases if symmetrical component quantities are specified.If no line code or impedance data are specified, the line object defaults to 336 MCM ACSR on 4 ft spacing.

DSS property name: LineCode, DSS property index: 3.

LineType: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

Code designating the type of line. One of: OH, UG, UG_TS, UG_CN, SWT_LDBRK, SWT_FUSE, SWT_SECT, SWT_REC, SWT_DISC, SWT_BRK, SWT_ELBOW, BUSBAR

OpenDSS currently does not use this internally. For whatever purpose the user defines. Default is OH.

DSS property name: LineType, DSS property index: 30.

LineType_str: List[str]#

‘property(…)’

Code designating the type of line. One of: OH, UG, UG_TS, UG_CN, SWT_LDBRK, SWT_FUSE, SWT_SECT, SWT_REC, SWT_DISC, SWT_BRK, SWT_ELBOW, BUSBAR

OpenDSS currently does not use this internally. For whatever purpose the user defines. Default is OH.

DSS property name: LineType, DSS property index: 30.

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]#

NormAmps: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Normal rated current.

DSS property name: NormAmps, DSS property index: 31.

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

NumCustomers() → altdss.types.Int32Array#

Number of customers for each branch in the batch.

Requires an energy meter with an updated zone.

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

ParentPDElement() → List[Optional[altdss.DSSObj.DSSObj]]#

Returns the parent PD element for each element in this batch.

Requires an energy meter with an updated zone.

PhaseLosses() → altdss.types.ComplexArray#

Complex array of losses (kVA) by phase

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

Phases: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

Number of phases, this line.

DSS property name: Phases, DSS property index: 5.

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

R0: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Zero-sequence Resistance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.

DSS property name: R0, DSS property index: 8.

R1: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Positive-sequence Resistance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Rmatrix.

DSS property name: R1, DSS property index: 6.

RMatrix: List[altdss.types.Float64Array]#

‘property(…)’

Resistance matrix, lower triangle, ohms per unit length. Order of the matrix is the number of phases. May be used to specify the impedance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: RMatrix, DSS property index: 12.

Ratings: List[altdss.types.Float64Array]#

‘property(…)’

An array of ratings to be used when the seasonal ratings flag is True. It can be used to insert multiple ratings to change during a QSTS simulation to evaluate different ratings in lines.

DSS property name: Ratings, DSS property index: 29.

Repair: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Hours to repair. Default is 3 hr.

DSS property name: Repair, DSS property index: 35.

Rg: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Carson earth return resistance per unit length used to compute impedance values at base frequency. Default is 0.01805 = 60 Hz value in ohms per kft (matches default line impedances). This value is required for harmonic solutions if you wish to adjust the earth return impedances for frequency. If not, set both Rg and Xg = 0.

DSS property name: Rg, DSS property index: 16.

Seasons: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

Defines the number of ratings to be defined for the wire, to be used only when defining seasonal ratings using the “Ratings” property.

DSS property name: Seasons, DSS property index: 28.

SectionID() → altdss.types.Int32Array#

Integer ID of the feeder section that each PDElement branch in this batch is part of.

Requires a previous call to RelCalc command

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

Spacing: List[altdss.LineSpacing.LineSpacing]#

‘property(…)’

Reference to a LineSpacing for use in a line constants calculation. Must be used in conjunction with the Wires property. Specify this before the wires property.

DSS property name: Spacing, DSS property index: 21.

Spacing_str: List[str]#

‘property(…)’

Reference to a LineSpacing for use in a line constants calculation. Must be used in conjunction with the Wires property. Specify this before the wires property.

DSS property name: Spacing, DSS property index: 21.

Switch: List[bool]#

‘property(…)’

{y/n | T/F} Default= no/false. Designates this line as a switch for graphics and algorithmic purposes. SIDE EFFECT: Sets r1 = 1.0; x1 = 1.0; r0 = 1.0; x0 = 1.0; c1 = 1.1 ; c0 = 1.0; length = 0.001; You must reset if you want something different.

DSS property name: Switch, DSS property index: 15.

TotalCustomers() → altdss.types.Int32Array#

Total number of customers from each branch of this batch to the end of the zone

Requires a circuit with an energy meter with an updated zone.

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

TotalKilometers() → altdss.types.Float64Array#

Total kilometers of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

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

TotalMiles() → altdss.types.Float64Array#

Total miles of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

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

Units: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

Length Units = {none | mi|kft|km|m|Ft|in|cm } Default is None - assumes length units match impedance units.

DSS property name: Units, DSS property index: 20.

Units_str: List[str]#

‘property(…)’

Length Units = {none | mi|kft|km|m|Ft|in|cm } Default is None - assumes length units match impedance units.

DSS property name: Units, DSS property index: 20.

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

X0: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Zero-sequence Reactance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.

DSS property name: X0, DSS property index: 9.

X1: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Positive-sequence Reactance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Xmatrix

DSS property name: X1, DSS property index: 7.

XMatrix: List[altdss.types.Float64Array]#

‘property(…)’

Reactance matrix, lower triangle, ohms per unit length. Order of the matrix is the number of phases. May be used to specify the impedance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: XMatrix, DSS property index: 13.

Xg: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Carson earth return reactance per unit length used to compute impedance values at base frequency. For making better frequency adjustments. Default is 0.155081 = 60 Hz value in ohms per kft (matches default line impedances). This value is required for harmonic solutions if you wish to adjust the earth return impedances for frequency. If not, set both Rg and Xg = 0.

DSS property name: Xg, DSS property index: 17.

__call__()#

__contains__(name: str) → bool#

__getitem__(name_or_idx)#

__init__(iobj)#

__iter__()#

__len__() → int#

batch(**kwargs)#: Creates a new batch handler of (existing) objects

batch_new(names: Optional[List[AnyStr]] = None, *, df=None, count: Optional[int] = None, begin_edit: Optional[bool] = None, **kwargs: typing_extensions.Unpack[altdss.Line.LineBatchProperties]) → altdss.Line.LineBatch#

Creates a new batch of Line objects

Either names, count or df is required.

Parameters:

begin_edit – The argument begin_edit indicates if the user want to leave the elements in the edit state, and requires a call to end_edit() or equivalent. The default begin_edit is set to None. With None, the behavior will be adjusted according the default of how the batch is created.
**kwargs – Pass keyword arguments equivalent to the DSS properties of the object.
names – When using a list of names, each new object will match the names from this list. begin_edit defaults to True if no arguments for properties were passed, False otherwise.
count – When using count, new objects will be created with based on a random prefix, with an increasing integer up to count. begin_edit defaults to True if no arguments for properties were passed, False otherwise.
df – Currently EXPERIMENTAL AND LIMITED, tries to get the columns from a dataframe to populate the names and the DSS properties. begin_edit defaults to False.

Returns:

Returns the new batch of DSS objects, wrapped in Python.

Note that, to make it easier for new users where the edit context might not be too relevant, AltDSS automatically opens/closes edit contexts for single properties if the object is not in the edit state already.

begin_edit() → None#

Marks for editing all DSS objects in the batch

In the editing mode, some final side-effects of changing properties are postponed until end_edit is called. This side-effects can be somewhat costly, like updating the model parameters or internal matrices.

If you don’t have any performance constraint, you may edit each property individually without worrying about using begin_edit and end_edit. For convenience, those are emitted automatically when editing single properties outside an edit block.

edit(**kwargs: typing_extensions.Unpack[altdss.Line.LineBatchProperties]) → altdss.Line.LineBatch#

Edit this Line batch.

This method will try to open a new edit context (if not already open), edit the properties, and finalize the edit context for objects in the batch. It can be seen as a shortcut to manually setting each property, or a Pythonic analogous (but extended) to the DSS BatchEdit command.

Parameters:: **kwargs – Pass keyword arguments equivalent to the DSS properties of the objects.
Returns:: Returns itself to allow call chaining.

end_edit(num_changes: int = 1) → None#

Leaves the editing states of all DSS objects in the batch

num_changes is required for a few classes to correctly match the official OpenDSS behavior and must be the number of properties modified in the current editing block. As of DSS C-API v0.13, this is only required for the Monitor class, when the Action property is used with the Process value.

find(name_or_idx: Union[AnyStr, int]) → altdss.DSSObj.DSSObj#: Returns an object from the collection by name or index; the index must be zero-based.

new(name: AnyStr, *, begin_edit: Optional[bool] = None, activate=False, **kwargs: typing_extensions.Unpack[altdss.Line.LineProperties]) → altdss.Line.Line#

Creates a new Line.

Parameters:

name – The object’s name is a required positional argument.
activate – Activation (setting activate to true) is useful for integration with the classic API, and some internal OpenDSS commands. If you interact with this object only via the Alt API, no need to activate it (due to performance costs).
begin_edit – This controls how the edit context is left after the object creation:

True: The object will be left in the edit state, requiring an end_edit call or equivalent.
False: No edit context is started.
None: If no properties are passed as keyword arguments, the object will be left in the edit state (assumes the user will fill the properties from Python attributes). Otherwise, the internal edit context will be finalized.

Parameters:: **kwargs – Pass keyword arguments equivalent to the DSS properties of the object.
Returns:: Returns the new DSS object, wrapped in Python.

Note that, to make it easier for new users where the edit context might not be too relevant, AltDSS automatically opens/closes edit contexts for single properties if the object is not in the edit state already.

pctEmergency(allNodes=False) → altdss.types.Float64Array#

For each element in the batch, calculate the maximum current across the conductors as a percentage of the emergency ampere rating.

By default, only the nodes from the first terminal is used for the maximum current, matching the behavior of the “export capacity” command. Pass allNodes=True to force the analysis to all terminals.

pctNormal(allNodes=False) → altdss.types.Float64Array#

For each element in the batch, calculate the maximum current across the conductors as a percentage of the normal ampere rating.

By default, only the nodes from the first terminal is used for the maximum current, matching the behavior of the “export capacity” command. Pass allNodes=True to force the analysis to all terminals.

pctPerm: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Percent of failures that become permanent. Default is 20.

DSS property name: pctPerm, DSS property index: 34.

rho: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Default=100 meter ohms. Earth resistivity used to compute earth correction factor. Overrides Line geometry definition if specified.

DSS property name: rho, DSS property index: 18.

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.Line.Line(api_util, ptr)#

Bases: altdss.DSSObj.DSSObj, altdss.CircuitElement.CircuitElementMixin, altdss.PDElement.PDElementMixin

AccumulatedL() → float#

Accumulated failure rate for this branch on downline.

Requires a previous call to RelCalc command

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

B0: float#

‘property(…)’

Alternate way to specify C0. MicroS per unit length

DSS property name: B0, DSS property index: 27.

B1: float#

‘property(…)’

Alternate way to specify C1. MicroS per unit length

DSS property name: B1, DSS property index: 26.

BaseFreq: float#

‘property(…)’

Base Frequency for ratings.

DSS property name: BaseFreq, DSS property index: 36.

Bus1: str#

‘property(…)’

Name of bus to which first terminal is connected. Example: bus1=busname (assumes all terminals connected in normal phase order) bus1=busname.3.1.2.0 (specify terminal to node connections explicitly)

DSS property name: Bus1, DSS property index: 1.

Bus2: str#

‘property(…)’

Name of bus to which 2nd terminal is connected.

DSS property name: Bus2, DSS property index: 2.

C0: float#

‘property(…)’

Zero-sequence capacitance, nf per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.See also B0.

DSS property name: C0, DSS property index: 11.

C1: float#

‘property(…)’

Positive-sequence capacitance, nf per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Cmatrix and B1.

DSS property name: C1, DSS property index: 10.

CMatrix: altdss.types.Float64Array#

‘property(…)’

Nodal Capacitance matrix, lower triangle, nf per unit length.Order of the matrix is the number of phases. May be used to specify the shunt capacitance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: CMatrix, DSS property index: 14.

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

Conductors: List[Union[altdss.WireData.WireData, altdss.CNData.CNData, altdss.TSData.TSData]]#

‘property(…)’

Array of WireData names for use in an overhead line constants calculation. Must be used in conjunction with the Spacing property. Specify the Spacing first, and “ncond” wires. May also be used to specify bare neutrals with cables, using “ncond-nphase” wires.

DSS property name: Wires, DSS property index: 22.

Conductors_str: List[str]#

‘property(…)’

Array of WireData names for use in an overhead line constants calculation. Must be used in conjunction with the Spacing property. Specify the Spacing first, and “ncond” wires. May also be used to specify bare neutrals with cables, using “ncond-nphase” wires.

DSS property name: Wires, DSS property index: 22.

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

EarthModel: altdss.enums.EarthModel#

‘property(…)’

One of {Carson | FullCarson | Deri}. Default is the global value established with the Set EarthModel command. See the Options Help on EarthModel option. This is used to override the global value for this line. This option applies only when the “geometry” property is used.

DSS property name: EarthModel, DSS property index: 23.

EarthModel_str: str#

‘property(…)’

One of {Carson | FullCarson | Deri}. Default is the global value established with the Set EarthModel command. See the Options Help on EarthModel option. This is used to override the global value for this line. This option applies only when the “geometry” property is used.

DSS property name: EarthModel, DSS property index: 23.

EmergAmps: float#

‘property(…)’

Maximum or emerg current.

DSS property name: EmergAmps, DSS property index: 32.

Enabled: bool#

‘property(…)’

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: Enabled, DSS property index: 37.

EnergyMeter() → Optional[altdss.DSSObj.DSSObj]#

Energy Meter this element is assigned to.

Requires an energy meter with an updated zone.

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

EnergyMeterName() → 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

FaultRate: float#

‘property(…)’

Failure rate PER UNIT LENGTH per year. Length must be same units as LENGTH property. Default is 0.1 fault per unit length per year.

DSS property name: FaultRate, DSS property index: 33.

FromTerminal() → int#

Number of the terminal of this PD element that is on the “from” side.

Requires an energy meter with an updated zone.

FullName() → str#

GUID() → str#

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

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

Geometry: altdss.LineGeometry.LineGeometry#

‘property(…)’

Geometry code for LineGeometry Object. Supersedes any previous definition of line impedance. Line constants are computed for each frequency change or rho change. CAUTION: may alter number of phases. You cannot subsequently change the number of phases unless you change how the line impedance is defined.

DSS property name: Geometry, DSS property index: 19.

Geometry_str: str#

‘property(…)’

Geometry code for LineGeometry Object. Supersedes any previous definition of line impedance. Line constants are computed for each frequency change or rho change. CAUTION: may alter number of phases. You cannot subsequently change the number of phases unless you change how the line impedance is defined.

DSS property name: Geometry, DSS property index: 19.

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.

IsShunt() → bool#

Indicates if this PD element should be treated as a shunt element rather than a series element.

Applies to Capacitor, Reactor, Fault and GICTransformer elements.

Lambda() → float#

Failure rate for this branch. Faults per year including length of line.

Requires a previous call to RelCalc command

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

Length: float#

‘property(…)’

Length of line. Default is 1.0. If units do not match the impedance data, specify “units” property.

DSS property name: Length, DSS property index: 4.

Like(value: AnyStr)#

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: Like, DSS property index: 38.

LineCode: altdss.LineCode.LineCode#

‘property(…)’

Name of linecode object describing line impedances. If you use a line code, you do not need to specify the impedances here. The line code must have been PREVIOUSLY defined. The values specified last will prevail over those specified earlier (left-to-right sequence of properties). You can subsequently change the number of phases if symmetrical component quantities are specified.If no line code or impedance data are specified, the line object defaults to 336 MCM ACSR on 4 ft spacing.

DSS property name: LineCode, DSS property index: 3.

LineCode_str: str#

‘property(…)’

Name of linecode object describing line impedances. If you use a line code, you do not need to specify the impedances here. The line code must have been PREVIOUSLY defined. The values specified last will prevail over those specified earlier (left-to-right sequence of properties). You can subsequently change the number of phases if symmetrical component quantities are specified.If no line code or impedance data are specified, the line object defaults to 336 MCM ACSR on 4 ft spacing.

DSS property name: LineCode, DSS property index: 3.

LineType: altdss.enums.LineType#

‘property(…)’

Code designating the type of line. One of: OH, UG, UG_TS, UG_CN, SWT_LDBRK, SWT_FUSE, SWT_SECT, SWT_REC, SWT_DISC, SWT_BRK, SWT_ELBOW, BUSBAR

OpenDSS currently does not use this internally. For whatever purpose the user defines. Default is OH.

DSS property name: LineType, DSS property index: 30.

LineType_str: str#

‘property(…)’

Code designating the type of line. One of: OH, UG, UG_TS, UG_CN, SWT_LDBRK, SWT_FUSE, SWT_SECT, SWT_REC, SWT_DISC, SWT_BRK, SWT_ELBOW, BUSBAR

OpenDSS currently does not use this internally. For whatever purpose the user defines. Default is OH.

DSS property name: LineType, DSS property index: 30.

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.

property Name: str#

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.

NormAmps: float#

‘property(…)’

Normal rated current.

DSS property name: NormAmps, DSS property index: 31.

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

NumCustomers() → int#

Number of customers, this branch.

Requires an energy meter with an updated zone.

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

ParentPDElement() → Optional[altdss.DSSObj.DSSObj]#

Parent PD element of this element, if any.

Requires an energy meter with an updated zone.

PhaseLosses() → altdss.types.ComplexArray#

Complex array of losses (kVA) by phase

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

Phases: int#

‘property(…)’

Number of phases, this line.

DSS property name: Phases, DSS property index: 5.

Powers() → altdss.types.ComplexArray#

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

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

R0: float#

‘property(…)’

Zero-sequence Resistance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.

DSS property name: R0, DSS property index: 8.

R1: float#

‘property(…)’

Positive-sequence Resistance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Rmatrix.

DSS property name: R1, DSS property index: 6.

RMatrix: altdss.types.Float64Array#

‘property(…)’

Resistance matrix, lower triangle, ohms per unit length. Order of the matrix is the number of phases. May be used to specify the impedance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: RMatrix, DSS property index: 12.

Ratings: altdss.types.Float64Array#

‘property(…)’

An array of ratings to be used when the seasonal ratings flag is True. It can be used to insert multiple ratings to change during a QSTS simulation to evaluate different ratings in lines.

DSS property name: Ratings, DSS property index: 29.

Repair: float#

‘property(…)’

Hours to repair. Default is 3 hr.

DSS property name: Repair, DSS property index: 35.

Residuals() → altdss.types.Float64Array#

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

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

Rg: float#

‘property(…)’

Carson earth return resistance per unit length used to compute impedance values at base frequency. Default is 0.01805 = 60 Hz value in ohms per kft (matches default line impedances). This value is required for harmonic solutions if you wish to adjust the earth return impedances for frequency. If not, set both Rg and Xg = 0.

DSS property name: Rg, DSS property index: 16.

Seasons: int#

‘property(…)’

Defines the number of ratings to be defined for the wire, to be used only when defining seasonal ratings using the “Ratings” property.

DSS property name: Seasons, DSS property index: 28.

SectionID() → int#

Integer ID of the feeder section that this PDElement branch is part of.

Requires a previous call to RelCalc command

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

Spacing: altdss.LineSpacing.LineSpacing#

‘property(…)’

Reference to a LineSpacing for use in a line constants calculation. Must be used in conjunction with the Wires property. Specify this before the wires property.

DSS property name: Spacing, DSS property index: 21.

Spacing_str: str#

‘property(…)’

Reference to a LineSpacing for use in a line constants calculation. Must be used in conjunction with the Wires property. Specify this before the wires property.

DSS property name: Spacing, DSS property index: 21.

Switch: bool#

‘property(…)’

{y/n | T/F} Default= no/false. Designates this line as a switch for graphics and algorithmic purposes. SIDE EFFECT: Sets r1 = 1.0; x1 = 1.0; r0 = 1.0; x0 = 1.0; c1 = 1.1 ; c0 = 1.0; length = 0.001; You must reset if you want something different.

DSS property name: Switch, DSS property index: 15.

TotalCustomers() → int#

Total number of customers from this branch to the end of the zone

Requires a circuit with an energy meter with an updated zone.

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

TotalKilometers() → float#

Total kilometers of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

TotalMiles() → float#

Total miles of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

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

Units: altdss.enums.LengthUnit#

‘property(…)’

Length Units = {none | mi|kft|km|m|Ft|in|cm } Default is None - assumes length units match impedance units.

DSS property name: Units, DSS property index: 20.

Units_str: str#

‘property(…)’

Length Units = {none | mi|kft|km|m|Ft|in|cm } Default is None - assumes length units match impedance units.

DSS property name: Units, DSS property index: 20.

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

X0: float#

‘property(…)’

Zero-sequence Reactance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.

DSS property name: X0, DSS property index: 9.

X1: float#

‘property(…)’

Positive-sequence Reactance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Xmatrix

DSS property name: X1, DSS property index: 7.

XMatrix: altdss.types.Float64Array#

‘property(…)’

Reactance matrix, lower triangle, ohms per unit length. Order of the matrix is the number of phases. May be used to specify the impedance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: XMatrix, DSS property index: 13.

Xg: float#

‘property(…)’

Carson earth return reactance per unit length used to compute impedance values at base frequency. For making better frequency adjustments. Default is 0.155081 = 60 Hz value in ohms per kft (matches default line impedances). This value is required for harmonic solutions if you wish to adjust the earth return impedances for frequency. If not, set both Rg and Xg = 0.

DSS property name: Xg, DSS property index: 17.

YPrim() → altdss.types.ComplexArray#

YPrim matrix, column order, complex numbers

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

__hash__()#: Return hash(self).

__init__(api_util, ptr)#

__ne__(other)#: Return self!=value.

__repr__()#: Return repr(self).

begin_edit() → None#

Marks a DSS object for editing

In the editing mode, some final side-effects of changing properties are postponed until end_edit is called. This side-effects can be somewhat costly, like updating the model parameters or internal matrices.

If you don’t have any performance constraint, you may edit each property individually without worrying about using begin_edit and end_edit. For convenience, those are emitted automatically when editing single properties outside an edit block.

edit(**kwargs: typing_extensions.Unpack[altdss.Line.LineProperties]) → altdss.Line.Line#

Edit this Line.

This method will try to open a new edit context (if not already open), edit the properties, and finalize the edit context. It can be seen as a shortcut to manually setting each property, or a Pythonic analogous (but extended) to the DSS Edit command.

Parameters:: **kwargs – Pass keyword arguments equivalent to the DSS properties of the object.
Returns:: Returns itself to allow call chaining.

end_edit(num_changes: int = 1) → None#

Leaves the editing state of a DSS object

num_changes is required for a few classes to correctly match the official OpenDSS behavior and must be the number of properties modified in the current editing block. As of DSS C-API v0.13, this is only required for the Monitor class, when the Action property is used with the Process value.

pctEmergency(allNodes=False) → float#

Maximum current across the conductors as a percentage of the emergency ampere rating.

By default, only the nodes from the first terminal is used for the maximum current, matching the behavior of the “export capacity” command. Pass allNodes=True to force the analysis to all terminals.

pctNormal(allNodes=False) → float#

Maximum current across the conductors as a percentage of the normal ampere rating.

By default, only the nodes from the first terminal is used for the maximum current, matching the behavior of the “export capacity” command. Pass allNodes=True to force the analysis to all terminals.

pctPerm: float#

‘property(…)’

Percent of failures that become permanent. Default is 20.

DSS property name: pctPerm, DSS property index: 34.

rho: float#

‘property(…)’

Default=100 meter ohms. Earth resistivity used to compute earth correction factor. Overrides Line geometry definition if specified.

DSS property name: rho, DSS property index: 18.

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

Returns an element’s data as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features.

By default (options = 0), only the properties explicitly set. The properties are returned in the order they are set in the input. As a reminder, OpenDSS is sensitive to the order of the properties.

The options bit-flags are available in the DSSJSONFlags enum. Values used by this function are:

Full: if set, all properties are returned, ordered by property index instead.
SkipRedundant: if used with Full, all properties except redundant and unused ones are returned.
EnumAsInt: enumerated properties are returned as integer values instead of strings.
FullNames: any element reference will use the full name ({class name}.{element name}) even if not required.
Pretty: more whitespace is used in the output for a “prettier” format.
SkipDSSClass: do not add the “DSSClass” property to the JSON objects.

NOT IMPLEMENTED YET:

State: include run-time state information
Debug: include debug information

Other bit-flags are reserved for future uses. Please use DSSJSONFlags enum to avoid potential conflicts.

(API Extension)

class altdss.Line.LineBatch(api_util, **kwargs)#

Bases: altdss.Batch.DSSBatch, altdss.CircuitElement.CircuitElementBatchMixin, altdss.PDElement.PDElementBatchMixin

AccumulatedL() → altdss.types.Float64Array#

Accumulated failure rate for the branch on downline, for each branch in this batch.

Requires a previous call to RelCalc command

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

B0: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Alternate way to specify C0. MicroS per unit length

DSS property name: B0, DSS property index: 27.

B1: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Alternate way to specify C1. MicroS per unit length

DSS property name: B1, DSS property index: 26.

BaseFreq: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Base Frequency for ratings.

DSS property name: BaseFreq, DSS property index: 36.

Bus1: List[str]#

‘property(…)’

Name of bus to which first terminal is connected. Example: bus1=busname (assumes all terminals connected in normal phase order) bus1=busname.3.1.2.0 (specify terminal to node connections explicitly)

DSS property name: Bus1, DSS property index: 1.

Bus2: List[str]#

‘property(…)’

Name of bus to which 2nd terminal is connected.

DSS property name: Bus2, DSS property index: 2.

C0: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Zero-sequence capacitance, nf per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.See also B0.

DSS property name: C0, DSS property index: 11.

C1: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Positive-sequence capacitance, nf per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Cmatrix and B1.

DSS property name: C1, DSS property index: 10.

CMatrix: List[altdss.types.Float64Array]#

‘property(…)’

Nodal Capacitance matrix, lower triangle, nf per unit length.Order of the matrix is the number of phases. May be used to specify the shunt capacitance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: CMatrix, DSS property index: 14.

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

Conductors: List[List[Union[altdss.WireData.WireData, altdss.CNData.CNData, altdss.TSData.TSData]]]#

‘property(…)’

Array of WireData names for use in an overhead line constants calculation. Must be used in conjunction with the Spacing property. Specify the Spacing first, and “ncond” wires. May also be used to specify bare neutrals with cables, using “ncond-nphase” wires.

DSS property name: Wires, DSS property index: 22.

Conductors_str: List[List[str]]#

‘property(…)’

Array of WireData names for use in an overhead line constants calculation. Must be used in conjunction with the Spacing property. Specify the Spacing first, and “ncond” wires. May also be used to specify bare neutrals with cables, using “ncond-nphase” wires.

DSS property name: Wires, DSS property index: 22.

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

EarthModel: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

One of {Carson | FullCarson | Deri}. Default is the global value established with the Set EarthModel command. See the Options Help on EarthModel option. This is used to override the global value for this line. This option applies only when the “geometry” property is used.

DSS property name: EarthModel, DSS property index: 23.

EarthModel_str: List[str]#

‘property(…)’

One of {Carson | FullCarson | Deri}. Default is the global value established with the Set EarthModel command. See the Options Help on EarthModel option. This is used to override the global value for this line. This option applies only when the “geometry” property is used.

DSS property name: EarthModel, DSS property index: 23.

EmergAmps: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Maximum or emerg current.

DSS property name: EmergAmps, DSS property index: 32.

Enabled: List[bool]#

‘property(…)’

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: Enabled, DSS property index: 37.

EnergyMeter() → List[Optional[altdss.DSSObj.DSSObj]]#

Return the energy meter for each of the elements in this batch.

Requires an energy meter with an updated zone.

EnergyMeterName() → List[str]#

Return the energy meter name for each of the elements in this batch.

Requires an energy meter with an updated zone.

FaultRate: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Failure rate PER UNIT LENGTH per year. Length must be same units as LENGTH property. Default is 0.1 fault per unit length per year.

DSS property name: FaultRate, DSS property index: 33.

FromTerminal() → altdss.types.Int32Array#

Number of the terminal of each PD element of this batch that is on the “from” side.

Requires an energy meter with an updated zone.

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

Geometry: List[altdss.LineGeometry.LineGeometry]#

‘property(…)’

Geometry code for LineGeometry Object. Supersedes any previous definition of line impedance. Line constants are computed for each frequency change or rho change. CAUTION: may alter number of phases. You cannot subsequently change the number of phases unless you change how the line impedance is defined.

DSS property name: Geometry, DSS property index: 19.

Geometry_str: List[str]#

‘property(…)’

Geometry code for LineGeometry Object. Supersedes any previous definition of line impedance. Line constants are computed for each frequency change or rho change. CAUTION: may alter number of phases. You cannot subsequently change the number of phases unless you change how the line impedance is defined.

DSS property name: Geometry, DSS property index: 19.

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.

IsShunt() → List[bool]#

Indicates if each of the PD elements in the batch should be treated as a shunt element rather than a series element.

Applies to Capacitor, Reactor, Fault and GICTransformer elements.

Lambda() → altdss.types.Float64Array#

Failure rate for each of the branches in the batch. Faults per year including length of line.

Requires a previous call to RelCalc command

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

Length: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Length of line. Default is 1.0. If units do not match the impedance data, specify “units” property.

DSS property name: Length, DSS property index: 4.

Like(value: AnyStr, flags: altdss.enums.SetterFlags = 0)#

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: Like, DSS property index: 38.

LineCode: List[altdss.LineCode.LineCode]#

‘property(…)’

Name of linecode object describing line impedances. If you use a line code, you do not need to specify the impedances here. The line code must have been PREVIOUSLY defined. The values specified last will prevail over those specified earlier (left-to-right sequence of properties). You can subsequently change the number of phases if symmetrical component quantities are specified.If no line code or impedance data are specified, the line object defaults to 336 MCM ACSR on 4 ft spacing.

DSS property name: LineCode, DSS property index: 3.

LineCode_str: List[str]#

‘property(…)’

Name of linecode object describing line impedances. If you use a line code, you do not need to specify the impedances here. The line code must have been PREVIOUSLY defined. The values specified last will prevail over those specified earlier (left-to-right sequence of properties). You can subsequently change the number of phases if symmetrical component quantities are specified.If no line code or impedance data are specified, the line object defaults to 336 MCM ACSR on 4 ft spacing.

DSS property name: LineCode, DSS property index: 3.

LineType: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

Code designating the type of line. One of: OH, UG, UG_TS, UG_CN, SWT_LDBRK, SWT_FUSE, SWT_SECT, SWT_REC, SWT_DISC, SWT_BRK, SWT_ELBOW, BUSBAR

OpenDSS currently does not use this internally. For whatever purpose the user defines. Default is OH.

DSS property name: LineType, DSS property index: 30.

LineType_str: List[str]#

‘property(…)’

Code designating the type of line. One of: OH, UG, UG_TS, UG_CN, SWT_LDBRK, SWT_FUSE, SWT_SECT, SWT_REC, SWT_DISC, SWT_BRK, SWT_ELBOW, BUSBAR

OpenDSS currently does not use this internally. For whatever purpose the user defines. Default is OH.

DSS property name: LineType, DSS property index: 30.

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]#

NormAmps: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Normal rated current.

DSS property name: NormAmps, DSS property index: 31.

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

NumCustomers() → altdss.types.Int32Array#

Number of customers for each branch in the batch.

Requires an energy meter with an updated zone.

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

ParentPDElement() → List[Optional[altdss.DSSObj.DSSObj]]#

Returns the parent PD element for each element in this batch.

Requires an energy meter with an updated zone.

PhaseLosses() → altdss.types.ComplexArray#

Complex array of losses (kVA) by phase

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

Phases: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

Number of phases, this line.

DSS property name: Phases, DSS property index: 5.

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

R0: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Zero-sequence Resistance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.

DSS property name: R0, DSS property index: 8.

R1: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Positive-sequence Resistance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Rmatrix.

DSS property name: R1, DSS property index: 6.

RMatrix: List[altdss.types.Float64Array]#

‘property(…)’

Resistance matrix, lower triangle, ohms per unit length. Order of the matrix is the number of phases. May be used to specify the impedance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: RMatrix, DSS property index: 12.

Ratings: List[altdss.types.Float64Array]#

‘property(…)’

An array of ratings to be used when the seasonal ratings flag is True. It can be used to insert multiple ratings to change during a QSTS simulation to evaluate different ratings in lines.

DSS property name: Ratings, DSS property index: 29.

Repair: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Hours to repair. Default is 3 hr.

DSS property name: Repair, DSS property index: 35.

Rg: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Carson earth return resistance per unit length used to compute impedance values at base frequency. Default is 0.01805 = 60 Hz value in ohms per kft (matches default line impedances). This value is required for harmonic solutions if you wish to adjust the earth return impedances for frequency. If not, set both Rg and Xg = 0.

DSS property name: Rg, DSS property index: 16.

Seasons: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

Defines the number of ratings to be defined for the wire, to be used only when defining seasonal ratings using the “Ratings” property.

DSS property name: Seasons, DSS property index: 28.

SectionID() → altdss.types.Int32Array#

Integer ID of the feeder section that each PDElement branch in this batch is part of.

Requires a previous call to RelCalc command

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

Spacing: List[altdss.LineSpacing.LineSpacing]#

‘property(…)’

Reference to a LineSpacing for use in a line constants calculation. Must be used in conjunction with the Wires property. Specify this before the wires property.

DSS property name: Spacing, DSS property index: 21.

Spacing_str: List[str]#

‘property(…)’

Reference to a LineSpacing for use in a line constants calculation. Must be used in conjunction with the Wires property. Specify this before the wires property.

DSS property name: Spacing, DSS property index: 21.

Switch: List[bool]#

‘property(…)’

{y/n | T/F} Default= no/false. Designates this line as a switch for graphics and algorithmic purposes. SIDE EFFECT: Sets r1 = 1.0; x1 = 1.0; r0 = 1.0; x0 = 1.0; c1 = 1.1 ; c0 = 1.0; length = 0.001; You must reset if you want something different.

DSS property name: Switch, DSS property index: 15.

TotalCustomers() → altdss.types.Int32Array#

Total number of customers from each branch of this batch to the end of the zone

Requires a circuit with an energy meter with an updated zone.

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

TotalKilometers() → altdss.types.Float64Array#

Total kilometers of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

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

TotalMiles() → altdss.types.Float64Array#

Total miles of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

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

Units: altdss.ArrayProxy.BatchInt32ArrayProxy#

‘property(…)’

Length Units = {none | mi|kft|km|m|Ft|in|cm } Default is None - assumes length units match impedance units.

DSS property name: Units, DSS property index: 20.

Units_str: List[str]#

‘property(…)’

Length Units = {none | mi|kft|km|m|Ft|in|cm } Default is None - assumes length units match impedance units.

DSS property name: Units, DSS property index: 20.

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

X0: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Zero-sequence Reactance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.

DSS property name: X0, DSS property index: 9.

X1: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Positive-sequence Reactance, ohms per unit length. Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Xmatrix

DSS property name: X1, DSS property index: 7.

XMatrix: List[altdss.types.Float64Array]#

‘property(…)’

Reactance matrix, lower triangle, ohms per unit length. Order of the matrix is the number of phases. May be used to specify the impedance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: XMatrix, DSS property index: 13.

Xg: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Carson earth return reactance per unit length used to compute impedance values at base frequency. For making better frequency adjustments. Default is 0.155081 = 60 Hz value in ohms per kft (matches default line impedances). This value is required for harmonic solutions if you wish to adjust the earth return impedances for frequency. If not, set both Rg and Xg = 0.

DSS property name: Xg, DSS property index: 17.

__call__()#

__getitem__(idx0) → altdss.DSSObj.DSSObj#: Get element at 0-based index of the batch pointer array

__init__(api_util, **kwargs)#

__iter__()#

__len__() → int#

batch(**kwargs) → altdss.Batch.DSSBatch#

Filter a batch using integer or float DSS properties, returning a new batch.

For integers, provide a single value to match.

For floats, provide a range as a 2-valued tuple/list (min value, max value), or an exact value to value (not recommended).

Multiple properties can be listed to allow filtering various conditions.

Example for loads:

    # Create an initial batch using a regular expression
    abc_loads = altdss.Load.batch(re=r'^abc.*$') # a batch of all loads with names starting with "abc"
    abc_loads_filtered = abc_loads.batch(Class=1, Phases=1, kV=(0.1, 1.0))

    # Create an initial batch, already filtered
    abc_loads_filtered = altdss.Load.batch(re=r'^abc.*$', Class=1, Phases=1, kV=(0.1, 1.0))

begin_edit() → None#

Marks for editing all DSS objects in the batch

In the editing mode, some final side-effects of changing properties are postponed until end_edit is called. This side-effects can be somewhat costly, like updating the model parameters or internal matrices.

If you don’t have any performance constraint, you may edit each property individually without worrying about using begin_edit and end_edit. For convenience, those are emitted automatically when editing single properties outside an edit block.

edit(**kwargs: typing_extensions.Unpack[altdss.Line.LineBatchProperties]) → altdss.Line.LineBatch#

Edit this Line batch.

This method will try to open a new edit context (if not already open), edit the properties, and finalize the edit context for objects in the batch. It can be seen as a shortcut to manually setting each property, or a Pythonic analogous (but extended) to the DSS BatchEdit command.

Parameters:: **kwargs – Pass keyword arguments equivalent to the DSS properties of the objects.
Returns:: Returns itself to allow call chaining.

end_edit(num_changes: int = 1) → None#

Leaves the editing states of all DSS objects in the batch

num_changes is required for a few classes to correctly match the official OpenDSS behavior and must be the number of properties modified in the current editing block. As of DSS C-API v0.13, this is only required for the Monitor class, when the Action property is used with the Process value.

pctEmergency(allNodes=False) → altdss.types.Float64Array#

For each element in the batch, calculate the maximum current across the conductors as a percentage of the emergency ampere rating.

By default, only the nodes from the first terminal is used for the maximum current, matching the behavior of the “export capacity” command. Pass allNodes=True to force the analysis to all terminals.

pctNormal(allNodes=False) → altdss.types.Float64Array#

For each element in the batch, calculate the maximum current across the conductors as a percentage of the normal ampere rating.

By default, only the nodes from the first terminal is used for the maximum current, matching the behavior of the “export capacity” command. Pass allNodes=True to force the analysis to all terminals.

pctPerm: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Percent of failures that become permanent. Default is 20.

DSS property name: pctPerm, DSS property index: 34.

rho: altdss.ArrayProxy.BatchFloat64ArrayProxy#

‘property(…)’

Default=100 meter ohms. Earth resistivity used to compute earth correction factor. Overrides Line geometry definition if specified.

DSS property name: rho, DSS property index: 18.

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.Line.LineBatchProperties#

Bases: typing_extensions.TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

B0: Union[float, altdss.types.Float64Array]#: None

B1: Union[float, altdss.types.Float64Array]#: None

BaseFreq: Union[float, altdss.types.Float64Array]#: None

Bus1: Union[AnyStr, List[AnyStr]]#: None

Bus2: Union[AnyStr, List[AnyStr]]#: None

C0: Union[float, altdss.types.Float64Array]#: None

C1: Union[float, altdss.types.Float64Array]#: None

CMatrix: altdss.types.Float64Array#: None

Conductors: Union[List[AnyStr], List[Union[altdss.WireData.WireData, altdss.CNData.CNData, altdss.TSData.TSData]]]#: None

EarthModel: Union[AnyStr, int, altdss.enums.EarthModel, List[AnyStr], List[int], List[altdss.enums.EarthModel], altdss.types.Int32Array]#: None

EmergAmps: Union[float, altdss.types.Float64Array]#: None

Enabled: bool#: None

FaultRate: Union[float, altdss.types.Float64Array]#: None

Geometry: Union[AnyStr, altdss.LineGeometry.LineGeometry, List[AnyStr], List[altdss.LineGeometry.LineGeometry]]#: None

Length: Union[float, altdss.types.Float64Array]#: None

Like: AnyStr#: None

LineCode: Union[AnyStr, altdss.LineCode.LineCode, List[AnyStr], List[altdss.LineCode.LineCode]]#: None

LineType: Union[AnyStr, int, altdss.enums.LineType, List[AnyStr], List[int], List[altdss.enums.LineType], altdss.types.Int32Array]#: None

NormAmps: Union[float, altdss.types.Float64Array]#: None

Phases: Union[int, altdss.types.Int32Array]#: None

R0: Union[float, altdss.types.Float64Array]#: None

R1: Union[float, altdss.types.Float64Array]#: None

RMatrix: altdss.types.Float64Array#: None

Ratings: altdss.types.Float64Array#: None

Repair: Union[float, altdss.types.Float64Array]#: None

Rg: Union[float, altdss.types.Float64Array]#: None

Seasons: Union[int, altdss.types.Int32Array]#: None

Spacing: Union[AnyStr, altdss.LineSpacing.LineSpacing, List[AnyStr], List[altdss.LineSpacing.LineSpacing]]#: None

Switch: bool#: None

Units: Union[AnyStr, int, altdss.enums.LengthUnit, List[AnyStr], List[int], List[altdss.enums.LengthUnit], altdss.types.Int32Array]#: None

X0: Union[float, altdss.types.Float64Array]#: None

X1: Union[float, altdss.types.Float64Array]#: None

XMatrix: altdss.types.Float64Array#: None

Xg: Union[float, altdss.types.Float64Array]#: None

__contains__()#: True if the dictionary has the specified key, else False.

__delattr__()#: Implement delattr(self, name).

__delitem__()#: Delete self[key].

__dir__()#: Default dir() implementation.

__format__()#

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__()#: Return self>=value.

__getattribute__()#: Return getattr(self, name).

__getitem__()#: Return self[key].

__getstate__()#: Helper for pickle.

__gt__()#: Return self>value.

__init__()#: Initialize self. See help(type(self)) for accurate signature.

__ior__()#: Return self|=value.

__iter__()#: Implement iter(self).

__le__()#: Return self<=value.

__len__()#: Return len(self).

__lt__()#: Return self<value.

__ne__()#: Return self!=value.

__new__()#: Create and return a new object. See help(type) for accurate signature.

__or__()#: Return self|value.

__reduce__()#: Helper for pickle.

__reduce_ex__()#: Helper for pickle.

__repr__()#: Return repr(self).

__reversed__()#: Return a reverse iterator over the dict keys.

__ror__()#: Return value|self.

__setitem__()#: Set self[key] to value.

__sizeof__()#: D.sizeof() -> size of D in memory, in bytes

__str__()#: Return str(self).

__subclasshook__()#

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.subclasscheck(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

clear()#: D.clear() -> None. Remove all items from D.

copy()#: D.copy() -> a shallow copy of D

get()#: Return the value for key if key is in the dictionary, else default.

items()#: D.items() -> a set-like object providing a view on D’s items

keys()#: D.keys() -> a set-like object providing a view on D’s keys

pctPerm: Union[float, altdss.types.Float64Array]#: None

pop()#

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

rho: Union[float, altdss.types.Float64Array]#: None

setdefault()#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update()#: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()#: D.values() -> an object providing a view on D’s values

class altdss.Line.LineProperties#

Bases: typing_extensions.TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

B0: float#: None

B1: float#: None

BaseFreq: float#: None

Bus1: AnyStr#: None

Bus2: AnyStr#: None

C0: float#: None

C1: float#: None

CMatrix: altdss.types.Float64Array#: None

Conductors: List[Union[AnyStr, Union[altdss.WireData.WireData, altdss.CNData.CNData, altdss.TSData.TSData]]]#: None

EarthModel: Union[AnyStr, int, altdss.enums.EarthModel]#: None

EmergAmps: float#: None

Enabled: bool#: None

FaultRate: float#: None

Geometry: Union[AnyStr, altdss.LineGeometry.LineGeometry]#: None

Length: float#: None

Like: AnyStr#: None

LineCode: Union[AnyStr, altdss.LineCode.LineCode]#: None

LineType: Union[AnyStr, int, altdss.enums.LineType]#: None

NormAmps: float#: None

Phases: int#: None

R0: float#: None

R1: float#: None

RMatrix: altdss.types.Float64Array#: None

Ratings: altdss.types.Float64Array#: None

Repair: float#: None

Rg: float#: None

Seasons: int#: None

Spacing: Union[AnyStr, altdss.LineSpacing.LineSpacing]#: None

Switch: bool#: None

Units: Union[AnyStr, int, altdss.enums.LengthUnit]#: None

X0: float#: None

X1: float#: None

XMatrix: altdss.types.Float64Array#: None

Xg: float#: None

__contains__()#: True if the dictionary has the specified key, else False.

__delattr__()#: Implement delattr(self, name).

__delitem__()#: Delete self[key].

__dir__()#: Default dir() implementation.

__format__()#

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__()#: Return self>=value.

__getattribute__()#: Return getattr(self, name).

__getitem__()#: Return self[key].

__getstate__()#: Helper for pickle.

__gt__()#: Return self>value.

__init__()#: Initialize self. See help(type(self)) for accurate signature.

__ior__()#: Return self|=value.

__iter__()#: Implement iter(self).

__le__()#: Return self<=value.

__len__()#: Return len(self).

__lt__()#: Return self<value.

__ne__()#: Return self!=value.

__new__()#: Create and return a new object. See help(type) for accurate signature.

__or__()#: Return self|value.

__reduce__()#: Helper for pickle.

__reduce_ex__()#: Helper for pickle.

__repr__()#: Return repr(self).

__reversed__()#: Return a reverse iterator over the dict keys.

__ror__()#: Return value|self.

__setitem__()#: Set self[key] to value.

__sizeof__()#: D.sizeof() -> size of D in memory, in bytes

__str__()#: Return str(self).

__subclasshook__()#

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.subclasscheck(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

clear()#: D.clear() -> None. Remove all items from D.

copy()#: D.copy() -> a shallow copy of D

get()#: Return the value for key if key is in the dictionary, else default.

items()#: D.items() -> a set-like object providing a view on D’s items

keys()#: D.keys() -> a set-like object providing a view on D’s keys

pctPerm: float#: None

pop()#

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

rho: float#: None

setdefault()#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update()#: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()#: D.values() -> an object providing a view on D’s values

`ILine`
`Line`
`LineBatch`
`LineBatchProperties`	dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)
`LineProperties`	dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Contents

`altdss.Line`#

Module Contents#

Classes#

API#

altdss.Line

Contents

altdss.Line#

Module Contents#

Classes#

API#

`altdss.Line`#