Class: Linecode¶
A Linecode object in OpenDSS defining per-unit-length impedance data shared by multiple lines. Depending on whether sequence impedances or matrices are provided, the converter creates either a PerLengthSequenceImpedance or a PerLengthPhaseImpedance + PhaseImpedanceData.
URI: dss:Linecode
classDiagram
class Linecode
click Linecode href "../Linecode/"
Linecode : B0
Linecode : B1
Linecode : baseFreq
Linecode : C0
Linecode : C1
Linecode : cmatrix
Linecode : emergamps
Linecode : faultrate
Linecode : Kron
Linecode : like
Linecode : LineType
Linecode : name
Linecode : neutral
Linecode : normamps
Linecode : nphases
Linecode : pctperm
Linecode : r0
Linecode : r1
Linecode : Ratings
Linecode : repair
Linecode : Rg
Linecode : rho
Linecode : rmatrix
Linecode : Seasons
Linecode : units
Linecode : x0
Linecode : x1
Linecode : Xg
Linecode : xmatrix
Class Properties¶
| Property | Value |
|---|---|
| Class URI | dss:Linecode |
Slots¶
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| name | 1 String |
Object name | direct |
| nphases | 0..1 Integer |
Number of phases in the line this line code data represents | direct |
| r1 | 0..1 Float |
Positive-sequence Resistance, ohms per unit length | direct |
| x1 | 0..1 Float |
Positive-sequence Reactance, ohms per unit length | direct |
| r0 | 0..1 Float |
Zero-sequence Resistance, ohms per unit length | direct |
| x0 | 0..1 Float |
Zero-sequence Reactance, ohms per unit length | direct |
| C1 | 0..1 String |
Positive-sequence capacitance, nf per unit length | direct |
| C0 | 0..1 String |
Zero-sequence capacitance, nf per unit length | direct |
| units | 0..1 String |
One of (none | mi |
| rmatrix | * Float |
Resistance matrix, lower triangle, ohms per unit length | direct |
| xmatrix | * Float |
Reactance matrix, lower triangle, ohms per unit length | direct |
| cmatrix | * Float |
Nodal Capacitance matrix, lower triangle, nf per unit length | direct |
| baseFreq | 0..1 String |
Frequency at which impedances are specified | direct |
| normamps | 0..1 Float |
Normal ampere limit on line | direct |
| emergamps | 0..1 Float |
Emergency ampere limit on line (usually one-hour rating) | direct |
| faultrate | 0..1 Integer |
Number of faults per unit length per year | direct |
| pctperm | 0..1 Float |
Percentage of the faults that become permanent | direct |
| repair | 0..1 String |
Hours to repair | direct |
| Kron | 0..1 String |
Kron = Y/N | direct |
| Rg | 0..1 Float |
Carson earth return resistance per unit length used to compute impedance valu... | direct |
| Xg | 0..1 Float |
Carson earth return reactance per unit length used to compute impedance value... | direct |
| rho | 0..1 Float |
Default=100 meter ohms | direct |
| neutral | 0..1 String |
Designates which conductor is the neutral conductor that will be eliminated b... | direct |
| B1 | 0..1 String |
Alternate way to specify C1 | direct |
| B0 | 0..1 String |
Alternate way to specify C0 | direct |
| Seasons | 0..1 Integer |
Defines the number of ratings to be defined for the wire, to be used only whe... | direct |
| Ratings | 0..1 Float |
An array of ratings to be used when the seasonal ratings flag is True | direct |
| LineType | 0..1 Float |
Code designating the type of line | direct |
| like | 0..1 String |
Make like another object, e | direct |
Comments¶
- OpenDSS Linecode maps to CIM PerLengthSequenceImpedance when sequence parameters (r1, x1, r0, x0, C1, C0) are used, or to PerLengthPhaseImpedance + PhaseImpedanceData when matrix parameters are used. All CIM impedance values are stored in SI units (ohm/m, S/m); DSS per-unit-length values are scaled by the units property on import and always exported in ohm/m (units=m).
Identifier and Mapping Information¶
Schema Source¶
- from schema: https://gridappsd.github.io/dss-graph/opendss
Mappings¶
| Mapping Type | Mapped Value |
|---|---|
| self | dss:Linecode |
| native | dss:Linecode |
| close | cim:PerLengthSequenceImpedance |
LinkML Source¶
Direct¶
name: Linecode
description: A Linecode object in OpenDSS defining per-unit-length impedance data
shared by multiple lines. Depending on whether sequence impedances or matrices are
provided, the converter creates either a PerLengthSequenceImpedance or a PerLengthPhaseImpedance
+ PhaseImpedanceData.
comments:
- OpenDSS Linecode maps to CIM PerLengthSequenceImpedance when sequence parameters
(r1, x1, r0, x0, C1, C0) are used, or to PerLengthPhaseImpedance + PhaseImpedanceData
when matrix parameters are used. All CIM impedance values are stored in SI units
(ohm/m, S/m); DSS per-unit-length values are scaled by the units property on import
and always exported in ohm/m (units=m).
from_schema: https://gridappsd.github.io/dss-graph/opendss
close_mappings:
- cim:PerLengthSequenceImpedance
attributes:
name:
name: name
description: Object name. Must be unique per object type.
comments:
- Direct name mapping; no conversion needed.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:IdentifiedObject.name
identifier: true
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: true
nphases:
name: nphases
annotations:
order:
tag: order
value: 1
dss_default:
tag: dss_default
value: int(3)
description: Number of phases in the line this line code data represents. Default
is 3.
comments:
- 'Import: determines routing to PerLengthSequenceImpedance (3-phase balanced,
no matrix given) or PerLengthPhaseImpedance (matrix given, or fewer than 3 phases).
Export: for PerLengthPhaseImpedance, nphases = conductorCount (or the highest
row index in PhaseImpedanceData if conductorCount is absent); for PerLengthSequenceImpedance,
nphases is always written as 3.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
rank: 1000
domain_of:
- Linecode
- Linegeometry
- Linespacing
range: integer
required: false
minimum_value: 1
maximum_value: 3
r1:
name: r1
annotations:
order:
tag: order
value: 2
description: Positive-sequence Resistance, ohms per unit length.
comments:
- 'Import: PerLengthSequenceImpedance.r = r1 converted to ohm/m via units. Export:
r1 = r in selected output units. CIM stores in ohm/m (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthSequenceImpedance.r
domain_of:
- Line
- Linecode
range: float
required: false
x1:
name: x1
annotations:
order:
tag: order
value: 3
description: Positive-sequence Reactance, ohms per unit length.
comments:
- 'Import: PerLengthSequenceImpedance.x = x1 converted to ohm/m. Export: x1 =
x.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthSequenceImpedance.x
domain_of:
- Line
- Linecode
range: float
required: false
r0:
name: r0
annotations:
order:
tag: order
value: 4
description: Zero-sequence Resistance, ohms per unit length.
comments:
- 'Import: PerLengthSequenceImpedance.r0 = r0 converted to ohm/m, or 0.0 if r0
is not specified. Export: r0 = r0.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthSequenceImpedance.r0
domain_of:
- Line
- Linecode
range: float
required: false
x0:
name: x0
annotations:
order:
tag: order
value: 5
description: Zero-sequence Reactance, ohms per unit length.
comments:
- 'Import: PerLengthSequenceImpedance.x0 = x0 converted to ohm/m, or 0.0 if x0
is not specified. Export: x0 = x0.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthSequenceImpedance.x0
domain_of:
- Line
- Linecode
range: float
required: false
C1:
name: C1
annotations:
order:
tag: order
value: 6
description: Positive-sequence capacitance, nf per unit length.
comments:
- 'Import: bch = 2π × 60 × C1_nF × 1e-9 × units_scale (S/m), or 0.0 if C1 is not
specified. Export: C1 = bch / (2π × 60) × 1e9 in nF/m, or omitted (null) if
bch is 0.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
close_mappings:
- cim:PerLengthSequenceImpedance.bch
domain_of:
- Line
- Linecode
range: string
required: false
C0:
name: C0
annotations:
order:
tag: order
value: 7
description: Zero-sequence capacitance, nf per unit length.
comments:
- 'Import: b0ch = 2π × 60 × C0_nF × 1e-9 × units_scale (S/m), or 0.0 if C0 is
not specified. Export: C0 = b0ch / (2π × 60) × 1e9 in nF/m, or omitted (null)
if b0ch is 0.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
close_mappings:
- cim:PerLengthSequenceImpedance.b0ch
domain_of:
- Line
- Linecode
range: string
required: false
units:
name: units
annotations:
order:
tag: order
value: 8
description: One of (none|mi|km|kft|m|ft|in|cm) for the length units. Default
is none (use Line object's units).
comments:
- 'OpenDSS-only (N/A): unit selector consumed during import for impedance per-length
conversion; not stored on CIM.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
domain_of:
- Line
- Linecode
- Linegeometry
- Linespacing
range: string
required: false
rmatrix:
name: rmatrix
annotations:
order:
tag: order
value: 9
dss_format:
tag: dss_format
value: matrix
description: Resistance matrix, lower triangle, ohms per unit length.
comments:
- 'Import: triggers creation of PerLengthPhaseImpedance + PhaseImpedanceData elements
instead of PerLengthSequenceImpedance.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:PerLengthPhaseImpedance
domain_of:
- Line
- Linecode
range: float
required: false
multivalued: true
xmatrix:
name: xmatrix
annotations:
order:
tag: order
value: 10
dss_format:
tag: dss_format
value: matrix
description: Reactance matrix, lower triangle, ohms per unit length.
comments:
- 'Import: processed alongside rmatrix into PhaseImpedanceData.x values.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:PerLengthPhaseImpedance
domain_of:
- Line
- Linecode
range: float
required: false
multivalued: true
cmatrix:
name: cmatrix
annotations:
order:
tag: order
value: 11
dss_format:
tag: dss_format
value: matrix
description: Nodal Capacitance matrix, lower triangle, nf per unit length.
comments:
- 'Import: each lower-triangle entry (row, col) is converted to a PhaseImpedanceData.b
value via b = 2π × 60 × C_nF × 1e-9 × units_scale (S/m); the full lower-triangle
is preserved (not reduced to a diagonal). Export: PhaseImpedanceData.b is converted
back to nF/m and reassembled into the lower-triangle cmatrix string.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:PerLengthPhaseImpedance
domain_of:
- Capacitor
- Line
- Linecode
range: float
required: false
multivalued: true
baseFreq:
name: baseFreq
annotations:
order:
tag: order
value: 12
description: Frequency at which impedances are specified. Default is 60 Hz.
comments:
- Not stored on CIM PerLengthImpedance; base frequency is a circuit-level property.
Used in C→susceptance conversion.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
rank: 1000
domain_of:
- Linecode
range: string
required: false
normamps:
name: normamps
annotations:
order:
tag: order
value: 13
description: Normal ampere limit on line.
todos:
- Per-length-impedance-level current limits not yet mapped. Should create a WireInfo.ratedCurrent
or OperationalLimitSet if this is needed.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:CurrentLimit
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Fault
range: float
required: false
emergamps:
name: emergamps
annotations:
order:
tag: order
value: 14
description: Emergency ampere limit on line (usually one-hour rating).
todos:
- Emergency rating not yet mapped; same path as normamps.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:CurrentLimit
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Fault
range: float
required: false
faultrate:
name: faultrate
annotations:
order:
tag: order
value: 15
description: Number of faults per unit length per year.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: integer
required: false
pctperm:
name: pctperm
annotations:
order:
tag: order
value: 16
description: Percentage of the faults that become permanent.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Reactor
- Linecode
- Fault
range: float
required: false
repair:
name: repair
annotations:
order:
tag: order
value: 17
description: Hours to repair.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: string
required: false
Kron:
name: Kron
annotations:
order:
tag: order
value: 18
description: Kron = Y/N. If Yes, performs Kron reduction after impedance matrix
is computed.
comments:
- 'OpenDSS-only (N/A): Kron reduction flag applied before CIM storage; result
is already reduced in the CIM object.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
rank: 1000
domain_of:
- Linecode
range: string
required: false
Rg:
name: Rg
annotations:
order:
tag: order
value: 19
description: Carson earth return resistance per unit length used to compute impedance
values at base frequency.
comments:
- 'Import: PerLengthImpedance.rg = Rg converted to ohm/m, set only if Rg is specified.
Export: Rg = rg.to(''ohmPerm'').'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthImpedance.rg
domain_of:
- Line
- Linecode
range: float
required: false
Xg:
name: Xg
annotations:
order:
tag: order
value: 20
description: Carson earth return reactance per unit length used to compute impedance
values at base frequency.
comments:
- 'Import: PerLengthImpedance.xg = Xg converted to ohm/m, set only if Xg is specified.
Export: Xg = xg.to(''ohmPerm'').'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthImpedance.xg
domain_of:
- Line
- Linecode
range: float
required: false
rho:
name: rho
annotations:
order:
tag: order
value: 21
description: Default=100 meter ohms. Earth resistivity.
comments:
- 'OpenDSS-only (N/A): earth resistivity; not persisted on CIM PerLengthImpedance.
Use EarthResistivity on the Line for this.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
domain_of:
- Line
- Linecode
range: float
required: false
neutral:
name: neutral
annotations:
order:
tag: order
value: 22
description: Designates which conductor is the neutral conductor that will be
eliminated by Kron reduction.
comments:
- 'OpenDSS-only (N/A): Kron reduction index; not persisted after reduction.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
rank: 1000
domain_of:
- Linecode
range: string
required: false
B1:
name: B1
annotations:
order:
tag: order
value: 23
description: Alternate way to specify C1. MicroS per unit length.
todos:
- B1 input path not yet implemented. B1 (µS/unit) → bch via bch = B1 × 1e-6 /
length_factor.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
close_mappings:
- cim:PerLengthSequenceImpedance.bch
domain_of:
- Line
- Linecode
range: string
required: false
B0:
name: B0
annotations:
order:
tag: order
value: 24
description: Alternate way to specify C0. MicroS per unit length.
todos:
- B0 input path not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
close_mappings:
- cim:PerLengthSequenceImpedance.b0ch
domain_of:
- Line
- Linecode
range: string
required: false
Seasons:
name: Seasons
annotations:
order:
tag: order
value: 25
description: Defines the number of ratings to be defined for the wire, to be used
only when defining seasonal ratings using the Ratings property.
comments:
- 'OpenDSS-only (N/A): seasonal ratings count; no direct CIM equivalent on PerLengthImpedance.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
domain_of:
- Line
- Transformer
- Storagecontroller
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Xfmrcode
range: integer
required: false
Ratings:
name: Ratings
annotations:
order:
tag: order
value: 26
description: An array of ratings to be used when the seasonal ratings flag is
True.
todos:
- Seasonal ratings converter not yet implemented for LineCode.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:OperationalLimit
domain_of:
- Line
- Transformer
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Xfmrcode
range: float
required: false
LineType:
name: LineType
annotations:
order:
tag: order
value: 27
description: Code designating the type of line.
todos:
- LineType → PSRType mapping not yet implemented for LineCode.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:PSRType
domain_of:
- Line
- Linecode
- Linegeometry
range: float
required: false
like:
name: like
annotations:
order:
tag: order
value: 28
description: 'Make like another object, e.g.: New LineCode.L2 like=L1 ...'
comments:
- 'OpenDSS-only (N/A): DSS template/copy directive resolved at parse time; no
CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: false
class_uri: dss:Linecode
Induced¶
name: Linecode
description: A Linecode object in OpenDSS defining per-unit-length impedance data
shared by multiple lines. Depending on whether sequence impedances or matrices are
provided, the converter creates either a PerLengthSequenceImpedance or a PerLengthPhaseImpedance
+ PhaseImpedanceData.
comments:
- OpenDSS Linecode maps to CIM PerLengthSequenceImpedance when sequence parameters
(r1, x1, r0, x0, C1, C0) are used, or to PerLengthPhaseImpedance + PhaseImpedanceData
when matrix parameters are used. All CIM impedance values are stored in SI units
(ohm/m, S/m); DSS per-unit-length values are scaled by the units property on import
and always exported in ohm/m (units=m).
from_schema: https://gridappsd.github.io/dss-graph/opendss
close_mappings:
- cim:PerLengthSequenceImpedance
attributes:
name:
name: name
description: Object name. Must be unique per object type.
comments:
- Direct name mapping; no conversion needed.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:IdentifiedObject.name
identifier: true
owner: Linecode
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: true
nphases:
name: nphases
annotations:
order:
tag: order
value: 1
dss_default:
tag: dss_default
value: int(3)
description: Number of phases in the line this line code data represents. Default
is 3.
comments:
- 'Import: determines routing to PerLengthSequenceImpedance (3-phase balanced,
no matrix given) or PerLengthPhaseImpedance (matrix given, or fewer than 3 phases).
Export: for PerLengthPhaseImpedance, nphases = conductorCount (or the highest
row index in PhaseImpedanceData if conductorCount is absent); for PerLengthSequenceImpedance,
nphases is always written as 3.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
rank: 1000
owner: Linecode
domain_of:
- Linecode
- Linegeometry
- Linespacing
range: integer
required: false
minimum_value: 1
maximum_value: 3
r1:
name: r1
annotations:
order:
tag: order
value: 2
description: Positive-sequence Resistance, ohms per unit length.
comments:
- 'Import: PerLengthSequenceImpedance.r = r1 converted to ohm/m via units. Export:
r1 = r in selected output units. CIM stores in ohm/m (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthSequenceImpedance.r
owner: Linecode
domain_of:
- Line
- Linecode
range: float
required: false
x1:
name: x1
annotations:
order:
tag: order
value: 3
description: Positive-sequence Reactance, ohms per unit length.
comments:
- 'Import: PerLengthSequenceImpedance.x = x1 converted to ohm/m. Export: x1 =
x.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthSequenceImpedance.x
owner: Linecode
domain_of:
- Line
- Linecode
range: float
required: false
r0:
name: r0
annotations:
order:
tag: order
value: 4
description: Zero-sequence Resistance, ohms per unit length.
comments:
- 'Import: PerLengthSequenceImpedance.r0 = r0 converted to ohm/m, or 0.0 if r0
is not specified. Export: r0 = r0.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthSequenceImpedance.r0
owner: Linecode
domain_of:
- Line
- Linecode
range: float
required: false
x0:
name: x0
annotations:
order:
tag: order
value: 5
description: Zero-sequence Reactance, ohms per unit length.
comments:
- 'Import: PerLengthSequenceImpedance.x0 = x0 converted to ohm/m, or 0.0 if x0
is not specified. Export: x0 = x0.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthSequenceImpedance.x0
owner: Linecode
domain_of:
- Line
- Linecode
range: float
required: false
C1:
name: C1
annotations:
order:
tag: order
value: 6
description: Positive-sequence capacitance, nf per unit length.
comments:
- 'Import: bch = 2π × 60 × C1_nF × 1e-9 × units_scale (S/m), or 0.0 if C1 is not
specified. Export: C1 = bch / (2π × 60) × 1e9 in nF/m, or omitted (null) if
bch is 0.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
close_mappings:
- cim:PerLengthSequenceImpedance.bch
owner: Linecode
domain_of:
- Line
- Linecode
range: string
required: false
C0:
name: C0
annotations:
order:
tag: order
value: 7
description: Zero-sequence capacitance, nf per unit length.
comments:
- 'Import: b0ch = 2π × 60 × C0_nF × 1e-9 × units_scale (S/m), or 0.0 if C0 is
not specified. Export: C0 = b0ch / (2π × 60) × 1e9 in nF/m, or omitted (null)
if b0ch is 0.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
close_mappings:
- cim:PerLengthSequenceImpedance.b0ch
owner: Linecode
domain_of:
- Line
- Linecode
range: string
required: false
units:
name: units
annotations:
order:
tag: order
value: 8
description: One of (none|mi|km|kft|m|ft|in|cm) for the length units. Default
is none (use Line object's units).
comments:
- 'OpenDSS-only (N/A): unit selector consumed during import for impedance per-length
conversion; not stored on CIM.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
owner: Linecode
domain_of:
- Line
- Linecode
- Linegeometry
- Linespacing
range: string
required: false
rmatrix:
name: rmatrix
annotations:
order:
tag: order
value: 9
dss_format:
tag: dss_format
value: matrix
description: Resistance matrix, lower triangle, ohms per unit length.
comments:
- 'Import: triggers creation of PerLengthPhaseImpedance + PhaseImpedanceData elements
instead of PerLengthSequenceImpedance.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:PerLengthPhaseImpedance
owner: Linecode
domain_of:
- Line
- Linecode
range: float
required: false
multivalued: true
xmatrix:
name: xmatrix
annotations:
order:
tag: order
value: 10
dss_format:
tag: dss_format
value: matrix
description: Reactance matrix, lower triangle, ohms per unit length.
comments:
- 'Import: processed alongside rmatrix into PhaseImpedanceData.x values.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:PerLengthPhaseImpedance
owner: Linecode
domain_of:
- Line
- Linecode
range: float
required: false
multivalued: true
cmatrix:
name: cmatrix
annotations:
order:
tag: order
value: 11
dss_format:
tag: dss_format
value: matrix
description: Nodal Capacitance matrix, lower triangle, nf per unit length.
comments:
- 'Import: each lower-triangle entry (row, col) is converted to a PhaseImpedanceData.b
value via b = 2π × 60 × C_nF × 1e-9 × units_scale (S/m); the full lower-triangle
is preserved (not reduced to a diagonal). Export: PhaseImpedanceData.b is converted
back to nF/m and reassembled into the lower-triangle cmatrix string.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:PerLengthPhaseImpedance
owner: Linecode
domain_of:
- Capacitor
- Line
- Linecode
range: float
required: false
multivalued: true
baseFreq:
name: baseFreq
annotations:
order:
tag: order
value: 12
description: Frequency at which impedances are specified. Default is 60 Hz.
comments:
- Not stored on CIM PerLengthImpedance; base frequency is a circuit-level property.
Used in C→susceptance conversion.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
rank: 1000
owner: Linecode
domain_of:
- Linecode
range: string
required: false
normamps:
name: normamps
annotations:
order:
tag: order
value: 13
description: Normal ampere limit on line.
todos:
- Per-length-impedance-level current limits not yet mapped. Should create a WireInfo.ratedCurrent
or OperationalLimitSet if this is needed.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:CurrentLimit
owner: Linecode
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Fault
range: float
required: false
emergamps:
name: emergamps
annotations:
order:
tag: order
value: 14
description: Emergency ampere limit on line (usually one-hour rating).
todos:
- Emergency rating not yet mapped; same path as normamps.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:CurrentLimit
owner: Linecode
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Fault
range: float
required: false
faultrate:
name: faultrate
annotations:
order:
tag: order
value: 15
description: Number of faults per unit length per year.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
owner: Linecode
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: integer
required: false
pctperm:
name: pctperm
annotations:
order:
tag: order
value: 16
description: Percentage of the faults that become permanent.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
owner: Linecode
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Reactor
- Linecode
- Fault
range: float
required: false
repair:
name: repair
annotations:
order:
tag: order
value: 17
description: Hours to repair.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
owner: Linecode
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: string
required: false
Kron:
name: Kron
annotations:
order:
tag: order
value: 18
description: Kron = Y/N. If Yes, performs Kron reduction after impedance matrix
is computed.
comments:
- 'OpenDSS-only (N/A): Kron reduction flag applied before CIM storage; result
is already reduced in the CIM object.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
rank: 1000
owner: Linecode
domain_of:
- Linecode
range: string
required: false
Rg:
name: Rg
annotations:
order:
tag: order
value: 19
description: Carson earth return resistance per unit length used to compute impedance
values at base frequency.
comments:
- 'Import: PerLengthImpedance.rg = Rg converted to ohm/m, set only if Rg is specified.
Export: Rg = rg.to(''ohmPerm'').'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthImpedance.rg
owner: Linecode
domain_of:
- Line
- Linecode
range: float
required: false
Xg:
name: Xg
annotations:
order:
tag: order
value: 20
description: Carson earth return reactance per unit length used to compute impedance
values at base frequency.
comments:
- 'Import: PerLengthImpedance.xg = Xg converted to ohm/m, set only if Xg is specified.
Export: Xg = xg.to(''ohmPerm'').'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
exact_mappings:
- cim:PerLengthImpedance.xg
owner: Linecode
domain_of:
- Line
- Linecode
range: float
required: false
rho:
name: rho
annotations:
order:
tag: order
value: 21
description: Default=100 meter ohms. Earth resistivity.
comments:
- 'OpenDSS-only (N/A): earth resistivity; not persisted on CIM PerLengthImpedance.
Use EarthResistivity on the Line for this.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
owner: Linecode
domain_of:
- Line
- Linecode
range: float
required: false
neutral:
name: neutral
annotations:
order:
tag: order
value: 22
description: Designates which conductor is the neutral conductor that will be
eliminated by Kron reduction.
comments:
- 'OpenDSS-only (N/A): Kron reduction index; not persisted after reduction.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
rank: 1000
owner: Linecode
domain_of:
- Linecode
range: string
required: false
B1:
name: B1
annotations:
order:
tag: order
value: 23
description: Alternate way to specify C1. MicroS per unit length.
todos:
- B1 input path not yet implemented. B1 (µS/unit) → bch via bch = B1 × 1e-6 /
length_factor.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
close_mappings:
- cim:PerLengthSequenceImpedance.bch
owner: Linecode
domain_of:
- Line
- Linecode
range: string
required: false
B0:
name: B0
annotations:
order:
tag: order
value: 24
description: Alternate way to specify C0. MicroS per unit length.
todos:
- B0 input path not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
close_mappings:
- cim:PerLengthSequenceImpedance.b0ch
owner: Linecode
domain_of:
- Line
- Linecode
range: string
required: false
Seasons:
name: Seasons
annotations:
order:
tag: order
value: 25
description: Defines the number of ratings to be defined for the wire, to be used
only when defining seasonal ratings using the Ratings property.
comments:
- 'OpenDSS-only (N/A): seasonal ratings count; no direct CIM equivalent on PerLengthImpedance.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
owner: Linecode
domain_of:
- Line
- Transformer
- Storagecontroller
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Xfmrcode
range: integer
required: false
Ratings:
name: Ratings
annotations:
order:
tag: order
value: 26
description: An array of ratings to be used when the seasonal ratings flag is
True.
todos:
- Seasonal ratings converter not yet implemented for LineCode.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:OperationalLimit
owner: Linecode
domain_of:
- Line
- Transformer
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Xfmrcode
range: float
required: false
LineType:
name: LineType
annotations:
order:
tag: order
value: 27
description: Code designating the type of line.
todos:
- LineType → PSRType mapping not yet implemented for LineCode.
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
related_mappings:
- cim:PSRType
owner: Linecode
domain_of:
- Line
- Linecode
- Linegeometry
range: float
required: false
like:
name: like
annotations:
order:
tag: order
value: 28
description: 'Make like another object, e.g.: New LineCode.L2 like=L1 ...'
comments:
- 'OpenDSS-only (N/A): DSS template/copy directive resolved at parse time; no
CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/general/linecode
owner: Linecode
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: false
class_uri: dss:Linecode