Class: Xfmrcode

A Xfmrcode object in OpenDSS representing a transformer library entry (catalog) that can be referenced by Transformer objects via the XfmrCode property.

URI: dss:Xfmrcode

 classDiagram
    class Xfmrcode
    click Xfmrcode href "../Xfmrcode/"
      Xfmrcode : conn

      Xfmrcode : conns

      Xfmrcode : emerghkVA

      Xfmrcode : flrise

      Xfmrcode : hsrise

      Xfmrcode : kV

      Xfmrcode : kVA

      Xfmrcode : kVAs

      Xfmrcode : kVs

      Xfmrcode : like

      Xfmrcode : m

      Xfmrcode : MaxTap

      Xfmrcode : MinTap

      Xfmrcode : n

      Xfmrcode : name

      Xfmrcode : normhkVA

      Xfmrcode : NumTaps

      Xfmrcode : pct_imag

      Xfmrcode : pct_loadloss

      Xfmrcode : pct_noloadloss

      Xfmrcode : pct_R

      Xfmrcode : pct_Rs

      Xfmrcode : phases

      Xfmrcode : ppm_antifloat

      Xfmrcode : Ratings

      Xfmrcode : RdcOhms

      Xfmrcode : Rneut

      Xfmrcode : Seasons

      Xfmrcode : tap

      Xfmrcode : taps

      Xfmrcode : thermal

      Xfmrcode : wdg

      Xfmrcode : windings

      Xfmrcode : X12

      Xfmrcode : X13

      Xfmrcode : X23

      Xfmrcode : Xhl

      Xfmrcode : Xht

      Xfmrcode : Xlt

      Xfmrcode : Xneut

      Xfmrcode : Xscarray

Class Properties

Property	Value
Class URI	dss:Xfmrcode

Slots

Name	Cardinality and Range	Description	Inheritance
name	1 String	Object name	direct
phases	0..1 Integer	Number of phases this transformer	direct
windings	0..1 Integer	Number of windings, this transformer	direct
wdg	0..1 Integer	Set this = to the number of the winding you wish to define	direct
conn	0..1 String	Connection of this winding	direct
kV	0..1 Float	For 2-or 3-phase, enter phase-phase kV rating	direct
kVA	0..1 Float	Base kVA rating of the winding	direct
tap	0..1 String	Per unit tap that this winding is normally on	direct
pct_R	0..1 Float	Percent resistance this winding	direct
Rneut	0..1 Float	Default = -1	direct
Xneut	0..1 Float	Neutral reactance of wye(star)-connected winding in actual ohms	direct
conns	* String	Use this to specify all the Winding connections at once using an array	direct
kVs	* Float	Use this to specify the kV ratings of all windings at once using an array	direct
kVAs	* Float	Use this to specify the kVA ratings of all windings at once using an array	direct
taps	* Float	Use this to specify the normal per unit taps of all windings at once	direct
Xhl	0..1 Float	Use this to specify the percent reactance, H-L (winding 1 to winding 2)	direct
Xht	0..1 Float	Use this to specify the percent reactance, H-T (winding 1 to winding 3)	direct
Xlt	0..1 Float	Use this to specify the percent reactance, L-T (winding 2 to winding 3)	direct
Xscarray	* Float	Use this to specify the percent reactance between all pairs of windings as an...	direct
thermal	0..1 String	Thermal time constant of the transformer in hours	direct
n	0..1 String	n Exponent for thermal properties in IEEE C57	direct
m	0..1 String	m Exponent for thermal properties in IEEE C57	direct
flrise	0..1 String	Temperature rise, deg C, for full load	direct
hsrise	0..1 String	Hot spot temperature rise, deg C	direct
pct_loadloss	0..1 Float	Percent load loss at full load	direct
pct_noloadloss	0..1 Float	Percent no load losses at rated excitation voltage	direct
normhkVA	0..1 Float	Normal maximum kVA rating of H winding (winding 1)	direct
emerghkVA	0..1 Float	Emergency (contingency) kVA rating of H winding (winding 1)	direct
MaxTap	0..1 String	Max per unit tap for the active winding	direct
MinTap	0..1 String	Min per unit tap for the active winding	direct
NumTaps	0..1 Integer	Total number of taps between min and max tap	direct
pct_imag	0..1 Float	Percent magnetizing current	direct
ppm_antifloat	0..1 Float	ppm (parts per million) anti-float factor	direct
pct_Rs	* Float	Use this property to specify all the winding %resistances using an array	direct
X12	0..1 Float	Alternative to Xhl for specifying the percent reactance from winding 1 to win...	direct
X13	0..1 Float	Alternative to Xht for specifying the percent reactance from winding 1 to win...	direct
X23	0..1 Float	Alternative to Xlt for specifying the percent reactance from winding 2 to win...	direct
RdcOhms	0..1 Float	Winding dc resistance in OHMS	direct
Seasons	0..1 Integer	Defines the number of ratings to be defined for the transformer, to be used o...	direct
Ratings	* Float	An array of ratings to be used when the seasonal ratings flag is True	direct
like	0..1 String	Make like another object, e	direct

Comments

• OpenDSS Xfmrcode maps to CIM TransformerTankInfo (catalog entry describing transformer construction), with a PowerTransformerInfo created as its parent container. Each winding is described by a TransformerEndInfo object attached to the TransformerTankInfo. No-load losses and exciting current for winding 1 are stored in a NoLoadTest; short-circuit reactances and load losses between winding pairs are stored in ShortCircuitTest objects, one per winding pair.

Identifier and Mapping Information

Schema Source

• from schema: https://gridappsd.github.io/dss-graph/opendss

Mappings

Mapping Type	Mapped Value
self	dss:Xfmrcode
native	dss:Xfmrcode
exact	cim:TransformerTankInfo

LinkML Source

Direct

name: Xfmrcode
description: A Xfmrcode object in OpenDSS representing a transformer library entry
  (catalog) that can be referenced by Transformer objects via the XfmrCode property.
comments:
- OpenDSS Xfmrcode maps to CIM TransformerTankInfo (catalog entry describing transformer
  construction), with a PowerTransformerInfo created as its parent container. Each
  winding is described by a TransformerEndInfo object attached to the TransformerTankInfo.
  No-load losses and exciting current for winding 1 are stored in a NoLoadTest; short-circuit
  reactances and load losses between winding pairs are stored in ShortCircuitTest
  objects, one per winding pair.
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:TransformerTankInfo
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/xfmrcode
    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
  phases:
    name: phases
    annotations:
      order:
        tag: order
        value: 1
      dss_default:
        tag: dss_default
        value: int(3)
    description: Number of phases this transformer. Default is 3.
    comments:
    - Not stored directly on CIM TransformerTankInfo; phase count is implicit in TransformerEndInfo
      configuration.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Xfmrcode
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: integer
    required: false
    minimum_value: 1
    maximum_value: 3
  windings:
    name: windings
    annotations:
      order:
        tag: order
        value: 2
      dss_default:
        tag: dss_default
        value: int(2)
    description: Number of windings, this transformer. Default is 2.
    comments:
    - 'Import: creates one TransformerEndInfo per winding on the TransformerTankInfo.
      Export: len(TransformerTankInfo.TransformerEndInfo).'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TransformerEndInfo
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: integer
    required: false
    minimum_value: 2
  wdg:
    name: wdg
    annotations:
      order:
        tag: order
        value: 3
    description: Set this = to the number of the winding you wish to define.
    comments:
    - 'OpenDSS-only (N/A): index selector consumed at parse time; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: integer
    required: false
  conn:
    name: conn
    annotations:
      order:
        tag: order
        value: 4
    description: Connection of this winding. Default is wye.
    comments:
    - 'Import: ''wye'' → WindingConnection.Y; ''delta'' → WindingConnection.D. Export:
      reverse enum lookup.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    exact_mappings:
    - cim:TransformerEndInfo.connectionKind
    domain_of:
    - Load
    - Generator
    - Generic5
    - Indmach012
    - Pvsystem
    - Storage
    - Windgen
    - Autotrans
    - Capacitor
    - Reactor
    - Transformer
    - Xfmrcode
    - Sensor
    range: string
    required: false
  kV:
    name: kV
    annotations:
      order:
        tag: order
        value: 5
    description: For 2-or 3-phase, enter phase-phase kV rating. Otherwise, enter actual
      winding voltage rating.
    todos:
    - 'Importer bug: writes TransformerEndInfo.ratedU instead of the real ratedVoltage
      field.'
    comments:
    - 'Import: sets a TransformerEndInfo.ratedU attribute, which is not a real TransformerEndInfo
      field (the correct field is ratedVoltage), so the value does not roundtrip to
      CIM-spec-compliant tools. Export: reads ratedVoltage.to(''kV'') if present,
      falling back to a legacy ratedU attribute for backward compatibility with data
      written by this importer. kVs[] is the array form.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TransformerEndInfo.ratedVoltage
    domain_of:
    - Load
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  kVA:
    name: kVA
    annotations:
      order:
        tag: order
        value: 6
    description: Base kVA rating of the winding.
    comments:
    - 'Import: TransformerEndInfo.ratedS = ApparentPower(kVA, ''kVA''). Export: kVA
      = ratedS.to(''kVA''). CIM stores in VA (SI base). kVAs[] is the array form.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    exact_mappings:
    - cim:TransformerEndInfo.ratedS
    domain_of:
    - Load
    - Generator
    - Generic5
    - Indmach012
    - Pvsystem
    - Storage
    - Windgen
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  tap:
    name: tap
    annotations:
      order:
        tag: order
        value: 7
    description: Per unit tap that this winding is normally on. Default is 1.0.
    todos:
    - tap/taps[] not read by the importer. If implemented, it should scale TransformerEndInfo.ratedVoltage
      rather than being stored separately.
    comments:
    - 'OpenDSS-only (N/A): the current converter never reads tap or taps[]; no CIM
      field is set from this property.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  pct_R:
    name: pct_R
    annotations:
      order:
        tag: order
        value: 8
      dss_name:
        tag: dss_name
        value: '%R'
    description: Percent resistance this winding. Default is 0.2%.
    comments:
    - 'Import: TransformerEndInfo.r converted from percent on winding kVA base to
      ohms via Zbase = kV² × 1000 / kVA; r = %R / 100 × Zbase. Export: %R = r / Zbase
      × 100, using the same Zbase formula. %Rs[] is the array form.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:TransformerEndInfo.r
    domain_of:
    - Pvsystem
    - Storage
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  Rneut:
    name: Rneut
    annotations:
      order:
        tag: order
        value: 9
    description: Default = -1. If negative, neutral is floating.
    comments:
    - 'OpenDSS-only (N/A): neutral impedance parameter; no CIM equivalent on TransformerEndInfo
      in the standard profile.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Load
    - Transformer
    - Xfmrcode
    range: float
    required: false
  Xneut:
    name: Xneut
    annotations:
      order:
        tag: order
        value: 10
    description: Neutral reactance of wye(star)-connected winding in actual ohms.
    comments:
    - 'OpenDSS-only (N/A): neutral reactance; no CIM equivalent on TransformerEndInfo.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Load
    - Transformer
    - Xfmrcode
    range: float
    required: false
  conns:
    name: conns
    annotations:
      order:
        tag: order
        value: 11
    description: Use this to specify all the Winding connections at once using an
      array.
    comments:
    - Array form of conn property. Each element maps to the corresponding TransformerEndInfo.connectionKind.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    exact_mappings:
    - cim:TransformerEndInfo.connectionKind
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
    multivalued: true
  kVs:
    name: kVs
    annotations:
      order:
        tag: order
        value: 12
    description: Use this to specify the kV ratings of all windings at once using
      an array.
    comments:
    - Array form of kV property; each element goes through the same ratedU/ratedVoltage
      path (see kV comments).
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TransformerEndInfo.ratedVoltage
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    - Sensor
    range: float
    required: false
    multivalued: true
    minimum_value: 0.0
  kVAs:
    name: kVAs
    annotations:
      order:
        tag: order
        value: 13
    description: Use this to specify the kVA ratings of all windings at once using
      an array.
    comments:
    - Array form of kVA property. Each element maps to the corresponding TransformerEndInfo.ratedS.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    exact_mappings:
    - cim:TransformerEndInfo.ratedS
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
    multivalued: true
    minimum_value: 0.0
  taps:
    name: taps
    annotations:
      order:
        tag: order
        value: 14
    description: Use this to specify the normal per unit taps of all windings at once.
    todos:
    - taps[] not read by the importer; see tap todos.
    comments:
    - 'OpenDSS-only (N/A): not read by the current converter (see tap comments).'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
    multivalued: true
  Xhl:
    name: Xhl
    annotations:
      order:
        tag: order
        value: 15
    description: Use this to specify the percent reactance, H-L (winding 1 to winding
      2). Default is 7.
    comments:
    - 'Import: a ShortCircuitTest is created for each winding pair with leakageImpedance
      = sqrt(r_pct² + Xhl²) × Zbase / 100, where r_pct is the sum of the two windings''
      %R and Zbase uses winding 1''s kVA as the test base; ShortCircuitTest.loss =
      r_pct / 100 × kVA_winding1. Export: the leakage impedance and %R are used to
      recover Xhl = sqrt(z_pct² − r_pct²), where z_pct = leakageImpedance × 100 /
      Zbase.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    rank: 1000
    domain_of:
    - Xfmrcode
    range: float
    required: false
  Xht:
    name: Xht
    annotations:
      order:
        tag: order
        value: 16
    description: Use this to specify the percent reactance, H-T (winding 1 to winding
      3). Default is 35.
    comments:
    - 'Import/export: same leakageImpedance formula as Xhl (see Xhl comments), applied
      to the H-T winding pair (windings 1 and 3); only used when 3 or more windings
      are present.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    rank: 1000
    domain_of:
    - Xfmrcode
    range: float
    required: false
  Xlt:
    name: Xlt
    annotations:
      order:
        tag: order
        value: 17
    description: Use this to specify the percent reactance, L-T (winding 2 to winding
      3). Default is 30.
    comments:
    - 'Import/export: same leakageImpedance formula as Xhl (see Xhl comments), applied
      to the L-T winding pair (windings 2 and 3); only used when 3 or more windings
      are present.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    rank: 1000
    domain_of:
    - Xfmrcode
    range: float
    required: false
  Xscarray:
    name: Xscarray
    annotations:
      order:
        tag: order
        value: 18
    description: Use this to specify the percent reactance between all pairs of windings
      as an array. Replaces Xhl, Xht, Xlt for >3-winding transformers.
    comments:
    - 'Import/export: array form giving one %Xsc entry per winding pair, in the order
      produced by iterating pairs (i, k) with i < k over winding indices; each entry
      uses the same leakageImpedance formula as Xhl (see Xhl comments). Used in place
      of Xhl/Xht/Xlt for transformers with more than 3 windings.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    domain_of:
    - Transformer
    - Xfmrcode
    range: float
    required: false
    multivalued: true
  thermal:
    name: thermal
    annotations:
      order:
        tag: order
        value: 19
    description: Thermal time constant of the transformer in hours.
    comments:
    - 'OpenDSS-only (N/A): thermal model parameter; no CIM equivalent in the standard
      profile.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  n:
    name: n
    annotations:
      order:
        tag: order
        value: 20
    description: n Exponent for thermal properties in IEEE C57.
    comments:
    - 'OpenDSS-only (N/A): IEEE C57 thermal exponent; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  m:
    name: m
    annotations:
      order:
        tag: order
        value: 21
    description: m Exponent for thermal properties in IEEE C57.
    comments:
    - 'OpenDSS-only (N/A): IEEE C57 thermal exponent; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  flrise:
    name: flrise
    annotations:
      order:
        tag: order
        value: 22
    description: Temperature rise, deg C, for full load.
    comments:
    - 'OpenDSS-only (N/A): thermal rating parameter; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  hsrise:
    name: hsrise
    annotations:
      order:
        tag: order
        value: 23
    description: Hot spot temperature rise, deg C.
    comments:
    - 'OpenDSS-only (N/A): hot spot thermal rating; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  pct_loadloss:
    name: pct_loadloss
    annotations:
      order:
        tag: order
        value: 24
      dss_name:
        tag: dss_name
        value: '%loadloss'
    description: Percent load loss at full load. Total winding resistive losses.
    todos:
    - '%loadloss is not exported; the exporter always recomputes %R per winding from
      TransformerEndInfo.r, so a roundtrip that only set %loadloss will export as
      %Rs[] instead.'
    comments:
    - 'Import fallback, used only when neither %R nor %Rs[] is given: each winding''s
      %R = %loadloss / num_windings (evenly split), then converted to ohms via the
      same Zbase formula as %R (see %R comments). No single CIM field stores a total
      load-loss percentage, so %loadloss is not re-derived or exported.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:TransformerEndInfo.r
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  pct_noloadloss:
    name: pct_noloadloss
    annotations:
      order:
        tag: order
        value: 25
      dss_name:
        tag: dss_name
        value: '%noloadloss'
    description: Percent no load losses at rated excitation voltage. Core losses.
    comments:
    - 'Import: NoLoadTest.loss = %noloadloss / 100 × kVA. Export: %noloadloss = NoLoadTest.loss
      / kVA × 100.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:NoLoadTest.loss
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  normhkVA:
    name: normhkVA
    annotations:
      order:
        tag: order
        value: 26
    description: Normal maximum kVA rating of H winding (winding 1).
    comments:
    - 'OpenDSS-only (N/A): operational limit; no CIM equivalent on TransformerTankInfo
      catalog object.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  emerghkVA:
    name: emerghkVA
    annotations:
      order:
        tag: order
        value: 27
    description: Emergency (contingency) kVA rating of H winding (winding 1).
    comments:
    - 'OpenDSS-only (N/A): emergency operational limit; no CIM equivalent on catalog
      object.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  MaxTap:
    name: MaxTap
    annotations:
      order:
        tag: order
        value: 28
    description: Max per unit tap for the active winding. Default is 1.10.
    todos:
    - No TapChangerInfo is created by the importer/exporter. MaxTap/MinTap/NumTaps
      should together populate TapChangerInfo.highStep/lowStep/stepVoltageIncrement,
      attached to the tapped TransformerEndInfo.
    comments:
    - 'OpenDSS-only (N/A) for now: not read by the current converter; no TapChangerInfo
      object is created for a Xfmrcode.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TapChangerInfo.highStep
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  MinTap:
    name: MinTap
    annotations:
      order:
        tag: order
        value: 29
    description: Min per unit tap for the active winding. Default is 0.90.
    todos:
    - Not implemented; see MaxTap todos.
    comments:
    - 'OpenDSS-only (N/A) for now: not read by the current converter (see MaxTap comments).'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TapChangerInfo.lowStep
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  NumTaps:
    name: NumTaps
    annotations:
      order:
        tag: order
        value: 30
    description: Total number of taps between min and max tap. Default is 32.
    todos:
    - Not implemented; see MaxTap todos.
    comments:
    - 'OpenDSS-only (N/A) for now: not read by the current converter (see MaxTap comments);
      if implemented, would combine with MaxTap/MinTap to derive TapChangerInfo.stepVoltageIncrement
      = (MaxTap - MinTap) / NumTaps.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TapChangerInfo.stepVoltageIncrement
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: integer
    required: false
  pct_imag:
    name: pct_imag
    annotations:
      order:
        tag: order
        value: 31
      dss_name:
        tag: dss_name
        value: '%imag'
    description: Percent magnetizing current.
    comments:
    - 'Import: NoLoadTest.excitingCurrent = sqrt(%imag² + %noloadloss²) (magnetizing
      and no-load-loss currents combined in quadrature). Export: %imag = sqrt(excitingCurrent²
      − %noloadloss²), or 0.0 if that value would be negative.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:NoLoadTest.excitingCurrent
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  ppm_antifloat:
    name: ppm_antifloat
    annotations:
      order:
        tag: order
        value: 32
    description: ppm (parts per million) anti-float factor. Default=1 ppm.
    comments:
    - 'OpenDSS-only (N/A): numerical stability parameter; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  pct_Rs:
    name: pct_Rs
    annotations:
      order:
        tag: order
        value: 33
      dss_name:
        tag: dss_name
        value: '%Rs'
    description: Use this property to specify all the winding %resistances using an
      array.
    comments:
    - Array form of %R property. Each element maps to the corresponding TransformerEndInfo.r
      via percent-to-ohm conversion.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:TransformerEndInfo.r
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
    multivalued: true
  X12:
    name: X12
    annotations:
      order:
        tag: order
        value: 34
    description: Alternative to Xhl for specifying the percent reactance from winding
      1 to winding 2.
    comments:
    - Alias for Xhl; maps to the same ShortCircuitTest for the H-L pair.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    domain_of:
    - Transformer
    - Xfmrcode
    range: float
    required: false
  X13:
    name: X13
    annotations:
      order:
        tag: order
        value: 35
    description: Alternative to Xht for specifying the percent reactance from winding
      1 to winding 3.
    comments:
    - Alias for Xht; maps to the same ShortCircuitTest for the H-T pair.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    domain_of:
    - Transformer
    - Xfmrcode
    range: float
    required: false
  X23:
    name: X23
    annotations:
      order:
        tag: order
        value: 36
    description: Alternative to Xlt for specifying the percent reactance from winding
      2 to winding 3.
    comments:
    - Alias for Xlt; maps to the same ShortCircuitTest for the L-T pair.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    domain_of:
    - Transformer
    - Xfmrcode
    range: float
    required: false
  RdcOhms:
    name: RdcOhms
    annotations:
      order:
        tag: order
        value: 37
    description: Winding dc resistance in OHMS.
    comments:
    - 'OpenDSS-only (N/A): DC resistance for loss calculation; no separate CIM field
      on TransformerEndInfo (CIM r is AC resistance).'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Transformer
    - Xfmrcode
    range: float
    required: false
  Seasons:
    name: Seasons
    annotations:
      order:
        tag: order
        value: 38
    description: Defines the number of ratings to be defined for the transformer,
      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 catalog
      object.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    domain_of:
    - Line
    - Transformer
    - Storagecontroller
    - Cndata
    - Linecode
    - Linegeometry
    - Tsdata
    - Wiredata
    - Xfmrcode
    range: integer
    required: false
  Ratings:
    name: Ratings
    annotations:
      order:
        tag: order
        value: 39
    description: An array of ratings to be used when the seasonal ratings flag is
      True.
    todos:
    - Seasonal ratings converter not yet implemented. Should map to multiple ApparentPowerLimit
      objects.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:OperationalLimit
    domain_of:
    - Line
    - Transformer
    - Cndata
    - Linecode
    - Linegeometry
    - Tsdata
    - Wiredata
    - Xfmrcode
    range: float
    required: false
    multivalued: true
  like:
    name: like
    annotations:
      order:
        tag: order
        value: 40
    description: 'Make like another object, e.g.: New XfmrCode.X2 like=X1 ...'
    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/xfmrcode
    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:Xfmrcode

Induced

name: Xfmrcode
description: A Xfmrcode object in OpenDSS representing a transformer library entry
  (catalog) that can be referenced by Transformer objects via the XfmrCode property.
comments:
- OpenDSS Xfmrcode maps to CIM TransformerTankInfo (catalog entry describing transformer
  construction), with a PowerTransformerInfo created as its parent container. Each
  winding is described by a TransformerEndInfo object attached to the TransformerTankInfo.
  No-load losses and exciting current for winding 1 are stored in a NoLoadTest; short-circuit
  reactances and load losses between winding pairs are stored in ShortCircuitTest
  objects, one per winding pair.
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:TransformerTankInfo
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/xfmrcode
    exact_mappings:
    - cim:IdentifiedObject.name
    identifier: true
    owner: Xfmrcode
    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
  phases:
    name: phases
    annotations:
      order:
        tag: order
        value: 1
      dss_default:
        tag: dss_default
        value: int(3)
    description: Number of phases this transformer. Default is 3.
    comments:
    - Not stored directly on CIM TransformerTankInfo; phase count is implicit in TransformerEndInfo
      configuration.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Xfmrcode
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: integer
    required: false
    minimum_value: 1
    maximum_value: 3
  windings:
    name: windings
    annotations:
      order:
        tag: order
        value: 2
      dss_default:
        tag: dss_default
        value: int(2)
    description: Number of windings, this transformer. Default is 2.
    comments:
    - 'Import: creates one TransformerEndInfo per winding on the TransformerTankInfo.
      Export: len(TransformerTankInfo.TransformerEndInfo).'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TransformerEndInfo
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: integer
    required: false
    minimum_value: 2
  wdg:
    name: wdg
    annotations:
      order:
        tag: order
        value: 3
    description: Set this = to the number of the winding you wish to define.
    comments:
    - 'OpenDSS-only (N/A): index selector consumed at parse time; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: integer
    required: false
  conn:
    name: conn
    annotations:
      order:
        tag: order
        value: 4
    description: Connection of this winding. Default is wye.
    comments:
    - 'Import: ''wye'' → WindingConnection.Y; ''delta'' → WindingConnection.D. Export:
      reverse enum lookup.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    exact_mappings:
    - cim:TransformerEndInfo.connectionKind
    owner: Xfmrcode
    domain_of:
    - Load
    - Generator
    - Generic5
    - Indmach012
    - Pvsystem
    - Storage
    - Windgen
    - Autotrans
    - Capacitor
    - Reactor
    - Transformer
    - Xfmrcode
    - Sensor
    range: string
    required: false
  kV:
    name: kV
    annotations:
      order:
        tag: order
        value: 5
    description: For 2-or 3-phase, enter phase-phase kV rating. Otherwise, enter actual
      winding voltage rating.
    todos:
    - 'Importer bug: writes TransformerEndInfo.ratedU instead of the real ratedVoltage
      field.'
    comments:
    - 'Import: sets a TransformerEndInfo.ratedU attribute, which is not a real TransformerEndInfo
      field (the correct field is ratedVoltage), so the value does not roundtrip to
      CIM-spec-compliant tools. Export: reads ratedVoltage.to(''kV'') if present,
      falling back to a legacy ratedU attribute for backward compatibility with data
      written by this importer. kVs[] is the array form.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TransformerEndInfo.ratedVoltage
    owner: Xfmrcode
    domain_of:
    - Load
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  kVA:
    name: kVA
    annotations:
      order:
        tag: order
        value: 6
    description: Base kVA rating of the winding.
    comments:
    - 'Import: TransformerEndInfo.ratedS = ApparentPower(kVA, ''kVA''). Export: kVA
      = ratedS.to(''kVA''). CIM stores in VA (SI base). kVAs[] is the array form.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    exact_mappings:
    - cim:TransformerEndInfo.ratedS
    owner: Xfmrcode
    domain_of:
    - Load
    - Generator
    - Generic5
    - Indmach012
    - Pvsystem
    - Storage
    - Windgen
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  tap:
    name: tap
    annotations:
      order:
        tag: order
        value: 7
    description: Per unit tap that this winding is normally on. Default is 1.0.
    todos:
    - tap/taps[] not read by the importer. If implemented, it should scale TransformerEndInfo.ratedVoltage
      rather than being stored separately.
    comments:
    - 'OpenDSS-only (N/A): the current converter never reads tap or taps[]; no CIM
      field is set from this property.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  pct_R:
    name: pct_R
    annotations:
      order:
        tag: order
        value: 8
      dss_name:
        tag: dss_name
        value: '%R'
    description: Percent resistance this winding. Default is 0.2%.
    comments:
    - 'Import: TransformerEndInfo.r converted from percent on winding kVA base to
      ohms via Zbase = kV² × 1000 / kVA; r = %R / 100 × Zbase. Export: %R = r / Zbase
      × 100, using the same Zbase formula. %Rs[] is the array form.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:TransformerEndInfo.r
    owner: Xfmrcode
    domain_of:
    - Pvsystem
    - Storage
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  Rneut:
    name: Rneut
    annotations:
      order:
        tag: order
        value: 9
    description: Default = -1. If negative, neutral is floating.
    comments:
    - 'OpenDSS-only (N/A): neutral impedance parameter; no CIM equivalent on TransformerEndInfo
      in the standard profile.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Load
    - Transformer
    - Xfmrcode
    range: float
    required: false
  Xneut:
    name: Xneut
    annotations:
      order:
        tag: order
        value: 10
    description: Neutral reactance of wye(star)-connected winding in actual ohms.
    comments:
    - 'OpenDSS-only (N/A): neutral reactance; no CIM equivalent on TransformerEndInfo.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Load
    - Transformer
    - Xfmrcode
    range: float
    required: false
  conns:
    name: conns
    annotations:
      order:
        tag: order
        value: 11
    description: Use this to specify all the Winding connections at once using an
      array.
    comments:
    - Array form of conn property. Each element maps to the corresponding TransformerEndInfo.connectionKind.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    exact_mappings:
    - cim:TransformerEndInfo.connectionKind
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
    multivalued: true
  kVs:
    name: kVs
    annotations:
      order:
        tag: order
        value: 12
    description: Use this to specify the kV ratings of all windings at once using
      an array.
    comments:
    - Array form of kV property; each element goes through the same ratedU/ratedVoltage
      path (see kV comments).
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TransformerEndInfo.ratedVoltage
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    - Sensor
    range: float
    required: false
    multivalued: true
    minimum_value: 0.0
  kVAs:
    name: kVAs
    annotations:
      order:
        tag: order
        value: 13
    description: Use this to specify the kVA ratings of all windings at once using
      an array.
    comments:
    - Array form of kVA property. Each element maps to the corresponding TransformerEndInfo.ratedS.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    exact_mappings:
    - cim:TransformerEndInfo.ratedS
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
    multivalued: true
    minimum_value: 0.0
  taps:
    name: taps
    annotations:
      order:
        tag: order
        value: 14
    description: Use this to specify the normal per unit taps of all windings at once.
    todos:
    - taps[] not read by the importer; see tap todos.
    comments:
    - 'OpenDSS-only (N/A): not read by the current converter (see tap comments).'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
    multivalued: true
  Xhl:
    name: Xhl
    annotations:
      order:
        tag: order
        value: 15
    description: Use this to specify the percent reactance, H-L (winding 1 to winding
      2). Default is 7.
    comments:
    - 'Import: a ShortCircuitTest is created for each winding pair with leakageImpedance
      = sqrt(r_pct² + Xhl²) × Zbase / 100, where r_pct is the sum of the two windings''
      %R and Zbase uses winding 1''s kVA as the test base; ShortCircuitTest.loss =
      r_pct / 100 × kVA_winding1. Export: the leakage impedance and %R are used to
      recover Xhl = sqrt(z_pct² − r_pct²), where z_pct = leakageImpedance × 100 /
      Zbase.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    rank: 1000
    owner: Xfmrcode
    domain_of:
    - Xfmrcode
    range: float
    required: false
  Xht:
    name: Xht
    annotations:
      order:
        tag: order
        value: 16
    description: Use this to specify the percent reactance, H-T (winding 1 to winding
      3). Default is 35.
    comments:
    - 'Import/export: same leakageImpedance formula as Xhl (see Xhl comments), applied
      to the H-T winding pair (windings 1 and 3); only used when 3 or more windings
      are present.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    rank: 1000
    owner: Xfmrcode
    domain_of:
    - Xfmrcode
    range: float
    required: false
  Xlt:
    name: Xlt
    annotations:
      order:
        tag: order
        value: 17
    description: Use this to specify the percent reactance, L-T (winding 2 to winding
      3). Default is 30.
    comments:
    - 'Import/export: same leakageImpedance formula as Xhl (see Xhl comments), applied
      to the L-T winding pair (windings 2 and 3); only used when 3 or more windings
      are present.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    rank: 1000
    owner: Xfmrcode
    domain_of:
    - Xfmrcode
    range: float
    required: false
  Xscarray:
    name: Xscarray
    annotations:
      order:
        tag: order
        value: 18
    description: Use this to specify the percent reactance between all pairs of windings
      as an array. Replaces Xhl, Xht, Xlt for >3-winding transformers.
    comments:
    - 'Import/export: array form giving one %Xsc entry per winding pair, in the order
      produced by iterating pairs (i, k) with i < k over winding indices; each entry
      uses the same leakageImpedance formula as Xhl (see Xhl comments). Used in place
      of Xhl/Xht/Xlt for transformers with more than 3 windings.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    owner: Xfmrcode
    domain_of:
    - Transformer
    - Xfmrcode
    range: float
    required: false
    multivalued: true
  thermal:
    name: thermal
    annotations:
      order:
        tag: order
        value: 19
    description: Thermal time constant of the transformer in hours.
    comments:
    - 'OpenDSS-only (N/A): thermal model parameter; no CIM equivalent in the standard
      profile.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  n:
    name: n
    annotations:
      order:
        tag: order
        value: 20
    description: n Exponent for thermal properties in IEEE C57.
    comments:
    - 'OpenDSS-only (N/A): IEEE C57 thermal exponent; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  m:
    name: m
    annotations:
      order:
        tag: order
        value: 21
    description: m Exponent for thermal properties in IEEE C57.
    comments:
    - 'OpenDSS-only (N/A): IEEE C57 thermal exponent; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  flrise:
    name: flrise
    annotations:
      order:
        tag: order
        value: 22
    description: Temperature rise, deg C, for full load.
    comments:
    - 'OpenDSS-only (N/A): thermal rating parameter; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  hsrise:
    name: hsrise
    annotations:
      order:
        tag: order
        value: 23
    description: Hot spot temperature rise, deg C.
    comments:
    - 'OpenDSS-only (N/A): hot spot thermal rating; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  pct_loadloss:
    name: pct_loadloss
    annotations:
      order:
        tag: order
        value: 24
      dss_name:
        tag: dss_name
        value: '%loadloss'
    description: Percent load loss at full load. Total winding resistive losses.
    todos:
    - '%loadloss is not exported; the exporter always recomputes %R per winding from
      TransformerEndInfo.r, so a roundtrip that only set %loadloss will export as
      %Rs[] instead.'
    comments:
    - 'Import fallback, used only when neither %R nor %Rs[] is given: each winding''s
      %R = %loadloss / num_windings (evenly split), then converted to ohms via the
      same Zbase formula as %R (see %R comments). No single CIM field stores a total
      load-loss percentage, so %loadloss is not re-derived or exported.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:TransformerEndInfo.r
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  pct_noloadloss:
    name: pct_noloadloss
    annotations:
      order:
        tag: order
        value: 25
      dss_name:
        tag: dss_name
        value: '%noloadloss'
    description: Percent no load losses at rated excitation voltage. Core losses.
    comments:
    - 'Import: NoLoadTest.loss = %noloadloss / 100 × kVA. Export: %noloadloss = NoLoadTest.loss
      / kVA × 100.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:NoLoadTest.loss
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  normhkVA:
    name: normhkVA
    annotations:
      order:
        tag: order
        value: 26
    description: Normal maximum kVA rating of H winding (winding 1).
    comments:
    - 'OpenDSS-only (N/A): operational limit; no CIM equivalent on TransformerTankInfo
      catalog object.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  emerghkVA:
    name: emerghkVA
    annotations:
      order:
        tag: order
        value: 27
    description: Emergency (contingency) kVA rating of H winding (winding 1).
    comments:
    - 'OpenDSS-only (N/A): emergency operational limit; no CIM equivalent on catalog
      object.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  MaxTap:
    name: MaxTap
    annotations:
      order:
        tag: order
        value: 28
    description: Max per unit tap for the active winding. Default is 1.10.
    todos:
    - No TapChangerInfo is created by the importer/exporter. MaxTap/MinTap/NumTaps
      should together populate TapChangerInfo.highStep/lowStep/stepVoltageIncrement,
      attached to the tapped TransformerEndInfo.
    comments:
    - 'OpenDSS-only (N/A) for now: not read by the current converter; no TapChangerInfo
      object is created for a Xfmrcode.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TapChangerInfo.highStep
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  MinTap:
    name: MinTap
    annotations:
      order:
        tag: order
        value: 29
    description: Min per unit tap for the active winding. Default is 0.90.
    todos:
    - Not implemented; see MaxTap todos.
    comments:
    - 'OpenDSS-only (N/A) for now: not read by the current converter (see MaxTap comments).'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TapChangerInfo.lowStep
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: string
    required: false
  NumTaps:
    name: NumTaps
    annotations:
      order:
        tag: order
        value: 30
    description: Total number of taps between min and max tap. Default is 32.
    todos:
    - Not implemented; see MaxTap todos.
    comments:
    - 'OpenDSS-only (N/A) for now: not read by the current converter (see MaxTap comments);
      if implemented, would combine with MaxTap/MinTap to derive TapChangerInfo.stepVoltageIncrement
      = (MaxTap - MinTap) / NumTaps.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:TapChangerInfo.stepVoltageIncrement
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: integer
    required: false
  pct_imag:
    name: pct_imag
    annotations:
      order:
        tag: order
        value: 31
      dss_name:
        tag: dss_name
        value: '%imag'
    description: Percent magnetizing current.
    comments:
    - 'Import: NoLoadTest.excitingCurrent = sqrt(%imag² + %noloadloss²) (magnetizing
      and no-load-loss currents combined in quadrature). Export: %imag = sqrt(excitingCurrent²
      − %noloadloss²), or 0.0 if that value would be negative.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:NoLoadTest.excitingCurrent
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  ppm_antifloat:
    name: ppm_antifloat
    annotations:
      order:
        tag: order
        value: 32
    description: ppm (parts per million) anti-float factor. Default=1 ppm.
    comments:
    - 'OpenDSS-only (N/A): numerical stability parameter; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
  pct_Rs:
    name: pct_Rs
    annotations:
      order:
        tag: order
        value: 33
      dss_name:
        tag: dss_name
        value: '%Rs'
    description: Use this property to specify all the winding %resistances using an
      array.
    comments:
    - Array form of %R property. Each element maps to the corresponding TransformerEndInfo.r
      via percent-to-ohm conversion.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:TransformerEndInfo.r
    owner: Xfmrcode
    domain_of:
    - Autotrans
    - Transformer
    - Xfmrcode
    range: float
    required: false
    multivalued: true
  X12:
    name: X12
    annotations:
      order:
        tag: order
        value: 34
    description: Alternative to Xhl for specifying the percent reactance from winding
      1 to winding 2.
    comments:
    - Alias for Xhl; maps to the same ShortCircuitTest for the H-L pair.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    owner: Xfmrcode
    domain_of:
    - Transformer
    - Xfmrcode
    range: float
    required: false
  X13:
    name: X13
    annotations:
      order:
        tag: order
        value: 35
    description: Alternative to Xht for specifying the percent reactance from winding
      1 to winding 3.
    comments:
    - Alias for Xht; maps to the same ShortCircuitTest for the H-T pair.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    owner: Xfmrcode
    domain_of:
    - Transformer
    - Xfmrcode
    range: float
    required: false
  X23:
    name: X23
    annotations:
      order:
        tag: order
        value: 36
    description: Alternative to Xlt for specifying the percent reactance from winding
      2 to winding 3.
    comments:
    - Alias for Xlt; maps to the same ShortCircuitTest for the L-T pair.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    close_mappings:
    - cim:ShortCircuitTest.leakageImpedance
    owner: Xfmrcode
    domain_of:
    - Transformer
    - Xfmrcode
    range: float
    required: false
  RdcOhms:
    name: RdcOhms
    annotations:
      order:
        tag: order
        value: 37
    description: Winding dc resistance in OHMS.
    comments:
    - 'OpenDSS-only (N/A): DC resistance for loss calculation; no separate CIM field
      on TransformerEndInfo (CIM r is AC resistance).'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Transformer
    - Xfmrcode
    range: float
    required: false
  Seasons:
    name: Seasons
    annotations:
      order:
        tag: order
        value: 38
    description: Defines the number of ratings to be defined for the transformer,
      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 catalog
      object.'
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    owner: Xfmrcode
    domain_of:
    - Line
    - Transformer
    - Storagecontroller
    - Cndata
    - Linecode
    - Linegeometry
    - Tsdata
    - Wiredata
    - Xfmrcode
    range: integer
    required: false
  Ratings:
    name: Ratings
    annotations:
      order:
        tag: order
        value: 39
    description: An array of ratings to be used when the seasonal ratings flag is
      True.
    todos:
    - Seasonal ratings converter not yet implemented. Should map to multiple ApparentPowerLimit
      objects.
    from_schema: https://gridappsd.github.io/dss-graph/general/xfmrcode
    related_mappings:
    - cim:OperationalLimit
    owner: Xfmrcode
    domain_of:
    - Line
    - Transformer
    - Cndata
    - Linecode
    - Linegeometry
    - Tsdata
    - Wiredata
    - Xfmrcode
    range: float
    required: false
    multivalued: true
  like:
    name: like
    annotations:
      order:
        tag: order
        value: 40
    description: 'Make like another object, e.g.: New XfmrCode.X2 like=X1 ...'
    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/xfmrcode
    owner: Xfmrcode
    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:Xfmrcode