Class: Regcontrol

A Regcontrol object in OpenDSS representing a voltage regulator control that monitors a transformer winding and adjusts its tap to regulate voltage.

URI: dss:Regcontrol

 classDiagram
    class Regcontrol
    click Regcontrol href "../Regcontrol/"
      Regcontrol : band

      Regcontrol : basefreq

      Regcontrol : bus

      Regcontrol : Cogen

      Regcontrol : CTprim

      Regcontrol : debugtrace

      Regcontrol : delay

      Regcontrol : enabled

      Regcontrol : EventLog

      Regcontrol : idle

      Regcontrol : idleForward

      Regcontrol : idleReverse

      Regcontrol : inversetime

      Regcontrol : LDC_Z

      Regcontrol : like

      Regcontrol : maxtapchange

      Regcontrol : name

      Regcontrol : PTphase

      Regcontrol : ptratio

      Regcontrol : R

      Regcontrol : RemotePTRatio

      Regcontrol : Reset

      Regcontrol : rev_Z

      Regcontrol : revband

      Regcontrol : revDelay

      Regcontrol : reversible

      Regcontrol : revNeutral

      Regcontrol : revR

      Regcontrol : revThreshold

      Regcontrol : revvreg

      Regcontrol : revX

      Regcontrol : tapdelay

      Regcontrol : TapNum

      Regcontrol : tapwinding

      Regcontrol : transformer

      Regcontrol : vlimit

      Regcontrol : vreg

      Regcontrol : winding

      Regcontrol : X

Class Properties

Property	Value
Class URI	dss:Regcontrol

Slots

Name	Cardinality and Range	Description	Inheritance
name	1 String	Object name	direct
transformer	0..1 String	Name of Transformer or AutoTrans element to which the RegControl is connected	direct
winding	0..1 Integer	Number of the winding of the transformer element that the RegControl is monit...	direct
vreg	0..1 Float	Voltage regulator setting, in VOLTS, for the winding being controlled	direct
band	0..1 String	Bandwidth in VOLTS for the controlled bus (full bandwidth)	direct
ptratio	0..1 Float	Ratio of the PT that converts the controlled winding voltage to the regulator...	direct
CTprim	0..1 Float	Rating, in Amperes, of the primary CT rating for which the line amps convert ...	direct
R	0..1 String	R setting on the line drop compensator in the regulator, expressed in VOLTS	direct
X	0..1 String	X setting on the line drop compensator in the regulator, expressed in VOLTS	direct
bus	0..1 Float	Name of a bus (busname	direct
delay	0..1 Float	Time delay, in seconds, from when the voltage goes out of band to when tap ch...	direct
reversible	0..1 Boolean	{Yes	No*} Indicates whether the regulator has a reverse operation mode
revvreg	0..1 Float	Voltage setting in volts for operation in the reverse direction	direct
revband	0..1 Float	Bandwidth for operating in the reverse direction	direct
revR	0..1 String	R line drop compensator setting for reverse direction	direct
revX	0..1 String	X line drop compensator setting for reverse direction	direct
tapdelay	0..1 String	Delay in sec between tap changes	direct
debugtrace	0..1 Boolean	{Yes	No* } Default is no
maxtapchange	0..1 Float	Maximum allowable tap change per control iteration in STATIC control mode	direct
inversetime	0..1 Boolean	{Yes	No* } Default is no
tapwinding	0..1 String	Winding containing the actual taps, if different than the WINDING property	direct
vlimit	0..1 Float	Voltage Limit for bus to which regulated winding is connected	direct
PTphase	0..1 Integer	For multi-phase transformers, the number of the phase being monitored or one ...	direct
revThreshold	0..1 Float	kW reverse power threshold for reversing the direction of the regulator	direct
revDelay	0..1 String	Time Delay in seconds for executing the reversing action once the threshold f...	direct
revNeutral	0..1 Boolean	{Yes	No*} Default is no
EventLog	0..1 String	{Yes/True*	No/False} Default is YES for regulator control
RemotePTRatio	0..1 Float	PT ratio required to convert actual voltage at the remote bus to control volt...	direct
TapNum	0..1 Integer	An integer number indicating the tap position that the controlled transformer...	direct
Reset	0..1 Boolean	{Yes	No} If Yes, forces Reset of this RegControl
LDC_Z	0..1 Float	Z value for Beckwith LDC_Z control option	direct
rev_Z	0..1 Float	Reverse Z value for Beckwith LDC_Z control option	direct
Cogen	0..1 Boolean	{Yes	No*} Default is No
idle	0..1 Boolean	{Yes	No*} Default is No
idleReverse	0..1 Boolean	{Yes	No*} Default is No
idleForward	0..1 Boolean	{Yes	No*} Default is No
basefreq	0..1 Float	Base Frequency for ratings	direct
enabled	0..1 Boolean	{Yes	No or True
like	0..1 String	Make like another object, e	direct

Comments

• Each DSS Regcontrol creates two CIM objects: TapChangerControl (the regulation settings: target voltage, bandwidth, line drop compensation, reverse settings) and RatioTapChanger (the physical tap changer on a specific transformer end: tap range, step size, PT/CT ratios). The end may be a PowerTransformerEnd or a TransformerTankEnd, depending on how the monitored transformer was imported (tank-based models are typical for regulators). The converter returns a tuple (TapChangerControl, RatioTapChanger).

Identifier and Mapping Information

Schema Source

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

Mappings

Mapping Type	Mapped Value
self	dss:Regcontrol
native	dss:Regcontrol
close	cim:TapChangerControl

LinkML Source

Direct

name: Regcontrol
description: A Regcontrol object in OpenDSS representing a voltage regulator control
  that monitors a transformer winding and adjusts its tap to regulate voltage.
comments:
- 'Each DSS Regcontrol creates two CIM objects: TapChangerControl (the regulation
  settings: target voltage, bandwidth, line drop compensation, reverse settings) and
  RatioTapChanger (the physical tap changer on a specific transformer end: tap range,
  step size, PT/CT ratios). The end may be a PowerTransformerEnd or a TransformerTankEnd,
  depending on how the monitored transformer was imported (tank-based models are typical
  for regulators). The converter returns a tuple (TapChangerControl, RatioTapChanger).'
from_schema: https://gridappsd.github.io/dss-graph/opendss
close_mappings:
- cim:TapChangerControl
attributes:
  name:
    name: name
    description: Object name. Must be unique per object type.
    comments:
    - Name applied to both RatioTapChanger and TapChangerControl.
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    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
  transformer:
    name: transformer
    annotations:
      order:
        tag: order
        value: 1
    description: Name of Transformer or AutoTrans element to which the RegControl
      is connected.
    comments:
    - 'Import: resolved by name to a PowerTransformerEnd or (for tank-based/regulator
      transformers) a TransformerTankEnd at the specified winding; RatioTapChanger.TransformerEnd
      = that end. Export: transformer = TransformerEnd.PowerTransformer.name, or TransformerEnd.TransformerTank.name
      for tank-based ends.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    related_mappings:
    - cim:RatioTapChanger.TransformerEnd
    rank: 1000
    domain_of:
    - Regcontrol
    range: string
    required: false
  winding:
    name: winding
    annotations:
      order:
        tag: order
        value: 2
    description: Number of the winding of the transformer element that the RegControl
      is monitoring. Default is 1.
    comments:
    - 'Import: selects the 1-based winding index to identify the PowerTransformerEnd
      for the RatioTapChanger. Export: winding = End.endNumber.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    related_mappings:
    - cim:RatioTapChanger.TransformerEnd
    rank: 1000
    domain_of:
    - Regcontrol
    range: integer
    required: false
  vreg:
    name: vreg
    annotations:
      order:
        tag: order
        value: 3
    description: Voltage regulator setting, in VOLTS, for the winding being controlled.
      Default is 120 V.
    comments:
    - 'Import: TapChangerControl.targetValue = vreg. Export: vreg = targetValue.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.targetValue
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
  band:
    name: band
    annotations:
      order:
        tag: order
        value: 4
    description: Bandwidth in VOLTS for the controlled bus (full bandwidth). Default
      is 3 V.
    comments:
    - 'Import: TapChangerControl.targetDeadband = band. Export: band = targetDeadband.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.targetDeadband
    rank: 1000
    domain_of:
    - Regcontrol
    range: string
    required: false
  ptratio:
    name: ptratio
    annotations:
      order:
        tag: order
        value: 5
    description: Ratio of the PT that converts the controlled winding voltage to the
      regulator control voltage. Default is 60.
    comments:
    - 'Import: RatioTapChanger.ptRatio = ptratio, or 60.0 if not specified. Export:
      ptratio = ptRatio.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:RatioTapChanger.ptRatio
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
    minimum_value: 0.0
  CTprim:
    name: CTprim
    annotations:
      order:
        tag: order
        value: 6
    description: Rating, in Amperes, of the primary CT rating for which the line amps
      convert to control rated amps. Default is 300 A.
    comments:
    - 'Import: RatioTapChanger.ctRating = CTprim, or 0.0 if not specified; when ctRating
      > 0, RatioTapChanger.ctRatio is also derived as ctRating / 0.2 (OpenDSS uses
      a fixed 0.2 A secondary). Export: CTprim = ctRating.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:RatioTapChanger.ctRating
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
  R:
    name: R
    annotations:
      order:
        tag: order
        value: 7
    description: R setting on the line drop compensator in the regulator, expressed
      in VOLTS.
    comments:
    - 'Import: TapChangerControl.lineDropR = R, or 0.0 if not specified; TapChangerControl.lineDropCompensation
      is set True if R or X is nonzero. Export: R = lineDropR.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.lineDropR
    domain_of:
    - Gicline
    - Capacitor
    - Reactor
    - Regcontrol
    range: string
    required: false
  X:
    name: X
    annotations:
      order:
        tag: order
        value: 8
    description: X setting on the line drop compensator in the regulator, expressed
      in VOLTS.
    comments:
    - 'Import: TapChangerControl.lineDropX = X, or 0.0 if not specified (see R comments
      for the lineDropCompensation flag). Export: X = lineDropX.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.lineDropX
    domain_of:
    - Gicline
    - Reactor
    - Regcontrol
    range: string
    required: false
  bus:
    name: bus
    annotations:
      order:
        tag: order
        value: 9
    description: Name of a bus (busname.nn.nn.nn) for remote voltage sensing. When
      set, the regulator monitors this bus instead of the transformer winding.
    comments:
    - 'OpenDSS-only (N/A): remote voltage sensing bus; no direct CIM equivalent on
      TapChangerControl.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    domain_of:
    - Autotrans
    - Transformer
    - Regcontrol
    range: float
    required: false
  delay:
    name: delay
    annotations:
      order:
        tag: order
        value: 10
    description: Time delay, in seconds, from when the voltage goes out of band to
      when tap changing begins. Default is 15 s.
    comments:
    - 'Import: RatioTapChanger.initialDelay = delay, or 15.0 if not specified. Export:
      delay = initialDelay.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:RatioTapChanger.initialDelay
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
  reversible:
    name: reversible
    annotations:
      order:
        tag: order
        value: 11
    description: '{Yes |No*} Indicates whether the regulator has a reverse operation
      mode.'
    comments:
    - 'Import: TapChangerControl.reversible = reversible. When False, none of the
      reverse-direction fields below (revvreg, revband, revR, revX, revDelay, revNeutral,
      revThreshold) are read — they keep CIM defaults. Export: reversible = TapChangerControl.reversible;
      the reverse-direction attributes below are only written when this is True.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reversible
    rank: 1000
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  revvreg:
    name: revvreg
    annotations:
      order:
        tag: order
        value: 12
    description: Voltage setting in volts for operation in the reverse direction.
      Default is 120 V.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reverseTargetValue = revvreg,
      or 120.0 if not specified. Export: revvreg = reverseTargetValue.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reverseTargetValue
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
  revband:
    name: revband
    annotations:
      order:
        tag: order
        value: 13
    description: Bandwidth for operating in the reverse direction. Default is 3 V.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reverseTargetDeadband
      = revband, or 3.0 if not specified. Export: revband = reverseTargetDeadband.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reverseTargetDeadband
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
  revR:
    name: revR
    annotations:
      order:
        tag: order
        value: 14
    description: R line drop compensator setting for reverse direction.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reverseLineDropR = revR,
      or 0.0 if not specified. Export: revR = reverseLineDropR.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reverseLineDropR
    rank: 1000
    domain_of:
    - Regcontrol
    range: string
    required: false
  revX:
    name: revX
    annotations:
      order:
        tag: order
        value: 15
    description: X line drop compensator setting for reverse direction.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reverseLineDropX = revX,
      or 0.0 if not specified. Export: revX = reverseLineDropX.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reverseLineDropX
    rank: 1000
    domain_of:
    - Regcontrol
    range: string
    required: false
  tapdelay:
    name: tapdelay
    annotations:
      order:
        tag: order
        value: 16
    description: Delay in sec between tap changes. Default is 2 s.
    comments:
    - 'Import: RatioTapChanger.subsequentDelay = tapdelay, or 2.0 if not specified.
      Export: tapdelay = subsequentDelay.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:RatioTapChanger.subsequentDelay
    rank: 1000
    domain_of:
    - Regcontrol
    range: string
    required: false
  debugtrace:
    name: debugtrace
    annotations:
      order:
        tag: order
        value: 17
    description: '{Yes | No* }  Default is no. If true, writes debug trace to file.'
    comments:
    - 'OpenDSS-only (N/A): debug logging flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    domain_of:
    - Generator
    - Pvsystem
    - Storage
    - Windgen
    - Regcontrol
    range: boolean
    required: false
  maxtapchange:
    name: maxtapchange
    annotations:
      order:
        tag: order
        value: 18
    description: Maximum allowable tap change per control iteration in STATIC control
      mode. Default is 16.
    comments:
    - 'OpenDSS-only (N/A): step limiter for static power-flow solution; no direct
      CIM equivalent on RatioTapChanger. Not read on import. Export writes maxtapchange=0
      only as a side effect of a disabled control (see enabled comments), to pin the
      tap at its current position; otherwise it is not written.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
  inversetime:
    name: inversetime
    annotations:
      order:
        tag: order
        value: 19
    description: '{Yes | No* } Default is no. If yes, time delays decrease inversely
      with magnitude of voltage excursion.'
    comments:
    - 'OpenDSS-only (N/A): inverse-time delay mode; no CIM equivalent in the standard
      profile.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  tapwinding:
    name: tapwinding
    annotations:
      order:
        tag: order
        value: 20
    description: Winding containing the actual taps, if different than the WINDING
      property.
    comments:
    - 'OpenDSS-only (N/A): tap winding override; no direct CIM equivalent (the RatioTapChanger
      is attached to the winding that carries taps).'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    domain_of:
    - Regcontrol
    range: string
    required: false
  vlimit:
    name: vlimit
    annotations:
      order:
        tag: order
        value: 21
    description: Voltage Limit for bus to which regulated winding is connected. Default
      is 0 (no limit).
    todos:
    - 'Converter bug: uses tcc.limitVoltage (not a real TapChangerControl field) instead
      of tcc.maxLimitVoltage on both import and export.'
    comments:
    - 'Intended target: TapChangerControl.maxLimitVoltage, set only when vlimit >
      0. Import/export currently read and write a dynamically added ``limitVoltage``
      attribute instead of the real maxLimitVoltage field, so vlimit roundtrips within
      this converter but is not visible to CIM-spec-compliant tools reading maxLimitVoltage.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    related_mappings:
    - cim:TapChangerControl.maxLimitVoltage
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
  PTphase:
    name: PTphase
    annotations:
      order:
        tag: order
        value: 22
    description: For multi-phase transformers, the number of the phase being monitored
      or one of {MAX | MIN} for all phases. Default is 1.
    comments:
    - 'OpenDSS-only (N/A): phase monitoring selector; no direct CIM equivalent on
      TapChangerControl.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    domain_of:
    - Regcontrol
    range: integer
    required: false
  revThreshold:
    name: revThreshold
    annotations:
      order:
        tag: order
        value: 23
    description: kW reverse power threshold for reversing the direction of the regulator.
      Default is 100 kW.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reversingPowerThreshold
      = −revThreshold (sign flipped; 0.0 if reversible but revThreshold not given).
      Export: revThreshold = −reversingPowerThreshold.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reversingPowerThreshold
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
  revDelay:
    name: revDelay
    annotations:
      order:
        tag: order
        value: 24
    description: Time Delay in seconds for executing the reversing action once the
      threshold for reversing has been exceeded. Default is 60 s.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reversingDelay = revDelay,
      or 60.0 if not specified. Export: revDelay = reversingDelay.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reversingDelay
    rank: 1000
    domain_of:
    - Regcontrol
    range: string
    required: false
  revNeutral:
    name: revNeutral
    annotations:
      order:
        tag: order
        value: 25
    description: '{Yes | No*} Default is no. If yes, regulator goes to neutral tap
      in reverse direction.'
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reverseToNeutral = revNeutral,
      or True if not specified. Export: revNeutral = reverseToNeutral.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reverseToNeutral
    rank: 1000
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  EventLog:
    name: EventLog
    annotations:
      order:
        tag: order
        value: 26
    description: '{Yes/True* | No/False} Default is YES for regulator control.'
    comments:
    - 'OpenDSS-only (N/A): debug logging flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    domain_of:
    - Capcontrol
    - Expcontrol
    - Invcontrol
    - Regcontrol
    - Relay
    - Storagecontroller
    range: string
    required: false
  RemotePTRatio:
    name: RemotePTRatio
    annotations:
      order:
        tag: order
        value: 27
    description: PT ratio required to convert actual voltage at the remote bus to
      control voltage when regulating a remote bus.
    comments:
    - 'OpenDSS-only (N/A): remote PT ratio; no CIM equivalent for remote bus voltage
      sensing in the standard profile.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
  TapNum:
    name: TapNum
    annotations:
      order:
        tag: order
        value: 28
    description: An integer number indicating the tap position that the controlled
      transformer winding tap position is currently at.
    comments:
    - 'Import: RatioTapChanger.step = 1.0 + TapNum × 0.00625 (SSH state; CIM step
      is a per-unit ratio around 1.0, DSS TapNum is an integer step count from neutral
      at a fixed 0.625%/step). Export: TapNum = round((step − 1.0) / (stepVoltageIncrement/100))
      using the RatioTapChanger''s own stepVoltageIncrement if set, otherwise the
      same 0.625%/step assumption.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    close_mappings:
    - cim:RatioTapChanger.step
    rank: 1000
    domain_of:
    - Regcontrol
    range: integer
    required: false
  Reset:
    name: Reset
    annotations:
      order:
        tag: order
        value: 29
    description: '{Yes | No} If Yes, forces Reset of this RegControl.'
    comments:
    - 'OpenDSS-only (N/A): operational reset flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    domain_of:
    - Capcontrol
    - Recloser
    - Regcontrol
    - Relay
    - Swtcontrol
    range: boolean
    required: false
  LDC_Z:
    name: LDC_Z
    annotations:
      order:
        tag: order
        value: 30
    description: Z value for Beckwith LDC_Z control option. Complex impedance in ohms.
    comments:
    - 'OpenDSS-only (N/A): Beckwith LDC_Z control mode parameter; no CIM equivalent
      in the standard profile.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
  rev_Z:
    name: rev_Z
    annotations:
      order:
        tag: order
        value: 31
    description: Reverse Z value for Beckwith LDC_Z control option.
    comments:
    - 'OpenDSS-only (N/A): Beckwith reverse LDC_Z parameter; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    domain_of:
    - Regcontrol
    range: float
    required: false
  Cogen:
    name: Cogen
    annotations:
      order:
        tag: order
        value: 32
    description: '{Yes|No*} Default is No. Cogen mode — sets direction of power flow
      sensing for reverse operation.'
    comments:
    - 'OpenDSS-only (N/A): co-generation mode flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  idle:
    name: idle
    annotations:
      order:
        tag: order
        value: 33
    description: '{Yes|No*} Default is No. If Yes, disables tap changing.'
    comments:
    - 'OpenDSS-only (N/A): idle/disable tap changing mode; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  idleReverse:
    name: idleReverse
    annotations:
      order:
        tag: order
        value: 34
    description: '{Yes|No*} Default is No. If Yes, disables tap changing in reverse
      mode.'
    comments:
    - 'OpenDSS-only (N/A): reverse idle mode; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  idleForward:
    name: idleForward
    annotations:
      order:
        tag: order
        value: 35
    description: '{Yes|No*} Default is No. If Yes, disables tap changing in forward
      mode.'
    comments:
    - 'OpenDSS-only (N/A): forward idle mode; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  basefreq:
    name: basefreq
    annotations:
      order:
        tag: order
        value: 36
    description: Base Frequency for ratings.
    comments:
    - Not stored on CIM TapChangerControl or RatioTapChanger; base frequency is a
      circuit-level property.
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    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
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: float
    required: false
  enabled:
    name: enabled
    annotations:
      order:
        tag: order
        value: 37
    description: '{Yes|No or True|False} Indicates whether this element is enabled.'
    comments:
    - 'Import: if enabled=No, the whole Regcontrol is skipped and no CIM objects are
      created; otherwise RatioTapChanger.controlEnabled = enabled (SSH attribute;
      also RatioTapChanger.ltcFlag is always set True, since OpenDSS regulators are
      load-tap-changing). Export: enabled = controlEnabled; when controlEnabled is
      False, maxtapchange is also written as 0 (see maxtapchange comments) so OpenDSS
      holds the tap at its imported position instead of re-regulating.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChanger.controlEnabled
    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
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: boolean
    required: false
  like:
    name: like
    annotations:
      order:
        tag: order
        value: 38
    description: 'Make like another object, e.g.: New Regcontrol.RC2 like=RC1 ...'
    comments:
    - 'OpenDSS-only (N/A): DSS template/copy directive resolved at parse time; no
      CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    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:Regcontrol

Induced

name: Regcontrol
description: A Regcontrol object in OpenDSS representing a voltage regulator control
  that monitors a transformer winding and adjusts its tap to regulate voltage.
comments:
- 'Each DSS Regcontrol creates two CIM objects: TapChangerControl (the regulation
  settings: target voltage, bandwidth, line drop compensation, reverse settings) and
  RatioTapChanger (the physical tap changer on a specific transformer end: tap range,
  step size, PT/CT ratios). The end may be a PowerTransformerEnd or a TransformerTankEnd,
  depending on how the monitored transformer was imported (tank-based models are typical
  for regulators). The converter returns a tuple (TapChangerControl, RatioTapChanger).'
from_schema: https://gridappsd.github.io/dss-graph/opendss
close_mappings:
- cim:TapChangerControl
attributes:
  name:
    name: name
    description: Object name. Must be unique per object type.
    comments:
    - Name applied to both RatioTapChanger and TapChangerControl.
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:IdentifiedObject.name
    identifier: true
    owner: Regcontrol
    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
  transformer:
    name: transformer
    annotations:
      order:
        tag: order
        value: 1
    description: Name of Transformer or AutoTrans element to which the RegControl
      is connected.
    comments:
    - 'Import: resolved by name to a PowerTransformerEnd or (for tank-based/regulator
      transformers) a TransformerTankEnd at the specified winding; RatioTapChanger.TransformerEnd
      = that end. Export: transformer = TransformerEnd.PowerTransformer.name, or TransformerEnd.TransformerTank.name
      for tank-based ends.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    related_mappings:
    - cim:RatioTapChanger.TransformerEnd
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: string
    required: false
  winding:
    name: winding
    annotations:
      order:
        tag: order
        value: 2
    description: Number of the winding of the transformer element that the RegControl
      is monitoring. Default is 1.
    comments:
    - 'Import: selects the 1-based winding index to identify the PowerTransformerEnd
      for the RatioTapChanger. Export: winding = End.endNumber.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    related_mappings:
    - cim:RatioTapChanger.TransformerEnd
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: integer
    required: false
  vreg:
    name: vreg
    annotations:
      order:
        tag: order
        value: 3
    description: Voltage regulator setting, in VOLTS, for the winding being controlled.
      Default is 120 V.
    comments:
    - 'Import: TapChangerControl.targetValue = vreg. Export: vreg = targetValue.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.targetValue
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
  band:
    name: band
    annotations:
      order:
        tag: order
        value: 4
    description: Bandwidth in VOLTS for the controlled bus (full bandwidth). Default
      is 3 V.
    comments:
    - 'Import: TapChangerControl.targetDeadband = band. Export: band = targetDeadband.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.targetDeadband
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: string
    required: false
  ptratio:
    name: ptratio
    annotations:
      order:
        tag: order
        value: 5
    description: Ratio of the PT that converts the controlled winding voltage to the
      regulator control voltage. Default is 60.
    comments:
    - 'Import: RatioTapChanger.ptRatio = ptratio, or 60.0 if not specified. Export:
      ptratio = ptRatio.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:RatioTapChanger.ptRatio
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
    minimum_value: 0.0
  CTprim:
    name: CTprim
    annotations:
      order:
        tag: order
        value: 6
    description: Rating, in Amperes, of the primary CT rating for which the line amps
      convert to control rated amps. Default is 300 A.
    comments:
    - 'Import: RatioTapChanger.ctRating = CTprim, or 0.0 if not specified; when ctRating
      > 0, RatioTapChanger.ctRatio is also derived as ctRating / 0.2 (OpenDSS uses
      a fixed 0.2 A secondary). Export: CTprim = ctRating.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:RatioTapChanger.ctRating
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
  R:
    name: R
    annotations:
      order:
        tag: order
        value: 7
    description: R setting on the line drop compensator in the regulator, expressed
      in VOLTS.
    comments:
    - 'Import: TapChangerControl.lineDropR = R, or 0.0 if not specified; TapChangerControl.lineDropCompensation
      is set True if R or X is nonzero. Export: R = lineDropR.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.lineDropR
    owner: Regcontrol
    domain_of:
    - Gicline
    - Capacitor
    - Reactor
    - Regcontrol
    range: string
    required: false
  X:
    name: X
    annotations:
      order:
        tag: order
        value: 8
    description: X setting on the line drop compensator in the regulator, expressed
      in VOLTS.
    comments:
    - 'Import: TapChangerControl.lineDropX = X, or 0.0 if not specified (see R comments
      for the lineDropCompensation flag). Export: X = lineDropX.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.lineDropX
    owner: Regcontrol
    domain_of:
    - Gicline
    - Reactor
    - Regcontrol
    range: string
    required: false
  bus:
    name: bus
    annotations:
      order:
        tag: order
        value: 9
    description: Name of a bus (busname.nn.nn.nn) for remote voltage sensing. When
      set, the regulator monitors this bus instead of the transformer winding.
    comments:
    - 'OpenDSS-only (N/A): remote voltage sensing bus; no direct CIM equivalent on
      TapChangerControl.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    owner: Regcontrol
    domain_of:
    - Autotrans
    - Transformer
    - Regcontrol
    range: float
    required: false
  delay:
    name: delay
    annotations:
      order:
        tag: order
        value: 10
    description: Time delay, in seconds, from when the voltage goes out of band to
      when tap changing begins. Default is 15 s.
    comments:
    - 'Import: RatioTapChanger.initialDelay = delay, or 15.0 if not specified. Export:
      delay = initialDelay.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:RatioTapChanger.initialDelay
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
  reversible:
    name: reversible
    annotations:
      order:
        tag: order
        value: 11
    description: '{Yes |No*} Indicates whether the regulator has a reverse operation
      mode.'
    comments:
    - 'Import: TapChangerControl.reversible = reversible. When False, none of the
      reverse-direction fields below (revvreg, revband, revR, revX, revDelay, revNeutral,
      revThreshold) are read — they keep CIM defaults. Export: reversible = TapChangerControl.reversible;
      the reverse-direction attributes below are only written when this is True.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reversible
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  revvreg:
    name: revvreg
    annotations:
      order:
        tag: order
        value: 12
    description: Voltage setting in volts for operation in the reverse direction.
      Default is 120 V.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reverseTargetValue = revvreg,
      or 120.0 if not specified. Export: revvreg = reverseTargetValue.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reverseTargetValue
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
  revband:
    name: revband
    annotations:
      order:
        tag: order
        value: 13
    description: Bandwidth for operating in the reverse direction. Default is 3 V.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reverseTargetDeadband
      = revband, or 3.0 if not specified. Export: revband = reverseTargetDeadband.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reverseTargetDeadband
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
  revR:
    name: revR
    annotations:
      order:
        tag: order
        value: 14
    description: R line drop compensator setting for reverse direction.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reverseLineDropR = revR,
      or 0.0 if not specified. Export: revR = reverseLineDropR.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reverseLineDropR
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: string
    required: false
  revX:
    name: revX
    annotations:
      order:
        tag: order
        value: 15
    description: X line drop compensator setting for reverse direction.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reverseLineDropX = revX,
      or 0.0 if not specified. Export: revX = reverseLineDropX.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reverseLineDropX
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: string
    required: false
  tapdelay:
    name: tapdelay
    annotations:
      order:
        tag: order
        value: 16
    description: Delay in sec between tap changes. Default is 2 s.
    comments:
    - 'Import: RatioTapChanger.subsequentDelay = tapdelay, or 2.0 if not specified.
      Export: tapdelay = subsequentDelay.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:RatioTapChanger.subsequentDelay
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: string
    required: false
  debugtrace:
    name: debugtrace
    annotations:
      order:
        tag: order
        value: 17
    description: '{Yes | No* }  Default is no. If true, writes debug trace to file.'
    comments:
    - 'OpenDSS-only (N/A): debug logging flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    owner: Regcontrol
    domain_of:
    - Generator
    - Pvsystem
    - Storage
    - Windgen
    - Regcontrol
    range: boolean
    required: false
  maxtapchange:
    name: maxtapchange
    annotations:
      order:
        tag: order
        value: 18
    description: Maximum allowable tap change per control iteration in STATIC control
      mode. Default is 16.
    comments:
    - 'OpenDSS-only (N/A): step limiter for static power-flow solution; no direct
      CIM equivalent on RatioTapChanger. Not read on import. Export writes maxtapchange=0
      only as a side effect of a disabled control (see enabled comments), to pin the
      tap at its current position; otherwise it is not written.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
  inversetime:
    name: inversetime
    annotations:
      order:
        tag: order
        value: 19
    description: '{Yes | No* } Default is no. If yes, time delays decrease inversely
      with magnitude of voltage excursion.'
    comments:
    - 'OpenDSS-only (N/A): inverse-time delay mode; no CIM equivalent in the standard
      profile.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  tapwinding:
    name: tapwinding
    annotations:
      order:
        tag: order
        value: 20
    description: Winding containing the actual taps, if different than the WINDING
      property.
    comments:
    - 'OpenDSS-only (N/A): tap winding override; no direct CIM equivalent (the RatioTapChanger
      is attached to the winding that carries taps).'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: string
    required: false
  vlimit:
    name: vlimit
    annotations:
      order:
        tag: order
        value: 21
    description: Voltage Limit for bus to which regulated winding is connected. Default
      is 0 (no limit).
    todos:
    - 'Converter bug: uses tcc.limitVoltage (not a real TapChangerControl field) instead
      of tcc.maxLimitVoltage on both import and export.'
    comments:
    - 'Intended target: TapChangerControl.maxLimitVoltage, set only when vlimit >
      0. Import/export currently read and write a dynamically added ``limitVoltage``
      attribute instead of the real maxLimitVoltage field, so vlimit roundtrips within
      this converter but is not visible to CIM-spec-compliant tools reading maxLimitVoltage.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    related_mappings:
    - cim:TapChangerControl.maxLimitVoltage
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
  PTphase:
    name: PTphase
    annotations:
      order:
        tag: order
        value: 22
    description: For multi-phase transformers, the number of the phase being monitored
      or one of {MAX | MIN} for all phases. Default is 1.
    comments:
    - 'OpenDSS-only (N/A): phase monitoring selector; no direct CIM equivalent on
      TapChangerControl.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: integer
    required: false
  revThreshold:
    name: revThreshold
    annotations:
      order:
        tag: order
        value: 23
    description: kW reverse power threshold for reversing the direction of the regulator.
      Default is 100 kW.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reversingPowerThreshold
      = −revThreshold (sign flipped; 0.0 if reversible but revThreshold not given).
      Export: revThreshold = −reversingPowerThreshold.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reversingPowerThreshold
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
  revDelay:
    name: revDelay
    annotations:
      order:
        tag: order
        value: 24
    description: Time Delay in seconds for executing the reversing action once the
      threshold for reversing has been exceeded. Default is 60 s.
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reversingDelay = revDelay,
      or 60.0 if not specified. Export: revDelay = reversingDelay.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reversingDelay
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: string
    required: false
  revNeutral:
    name: revNeutral
    annotations:
      order:
        tag: order
        value: 25
    description: '{Yes | No*} Default is no. If yes, regulator goes to neutral tap
      in reverse direction.'
    comments:
    - 'Import (only when reversible=Yes): TapChangerControl.reverseToNeutral = revNeutral,
      or True if not specified. Export: revNeutral = reverseToNeutral.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChangerControl.reverseToNeutral
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  EventLog:
    name: EventLog
    annotations:
      order:
        tag: order
        value: 26
    description: '{Yes/True* | No/False} Default is YES for regulator control.'
    comments:
    - 'OpenDSS-only (N/A): debug logging flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    owner: Regcontrol
    domain_of:
    - Capcontrol
    - Expcontrol
    - Invcontrol
    - Regcontrol
    - Relay
    - Storagecontroller
    range: string
    required: false
  RemotePTRatio:
    name: RemotePTRatio
    annotations:
      order:
        tag: order
        value: 27
    description: PT ratio required to convert actual voltage at the remote bus to
      control voltage when regulating a remote bus.
    comments:
    - 'OpenDSS-only (N/A): remote PT ratio; no CIM equivalent for remote bus voltage
      sensing in the standard profile.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
  TapNum:
    name: TapNum
    annotations:
      order:
        tag: order
        value: 28
    description: An integer number indicating the tap position that the controlled
      transformer winding tap position is currently at.
    comments:
    - 'Import: RatioTapChanger.step = 1.0 + TapNum × 0.00625 (SSH state; CIM step
      is a per-unit ratio around 1.0, DSS TapNum is an integer step count from neutral
      at a fixed 0.625%/step). Export: TapNum = round((step − 1.0) / (stepVoltageIncrement/100))
      using the RatioTapChanger''s own stepVoltageIncrement if set, otherwise the
      same 0.625%/step assumption.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    close_mappings:
    - cim:RatioTapChanger.step
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: integer
    required: false
  Reset:
    name: Reset
    annotations:
      order:
        tag: order
        value: 29
    description: '{Yes | No} If Yes, forces Reset of this RegControl.'
    comments:
    - 'OpenDSS-only (N/A): operational reset flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    owner: Regcontrol
    domain_of:
    - Capcontrol
    - Recloser
    - Regcontrol
    - Relay
    - Swtcontrol
    range: boolean
    required: false
  LDC_Z:
    name: LDC_Z
    annotations:
      order:
        tag: order
        value: 30
    description: Z value for Beckwith LDC_Z control option. Complex impedance in ohms.
    comments:
    - 'OpenDSS-only (N/A): Beckwith LDC_Z control mode parameter; no CIM equivalent
      in the standard profile.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
  rev_Z:
    name: rev_Z
    annotations:
      order:
        tag: order
        value: 31
    description: Reverse Z value for Beckwith LDC_Z control option.
    comments:
    - 'OpenDSS-only (N/A): Beckwith reverse LDC_Z parameter; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: float
    required: false
  Cogen:
    name: Cogen
    annotations:
      order:
        tag: order
        value: 32
    description: '{Yes|No*} Default is No. Cogen mode — sets direction of power flow
      sensing for reverse operation.'
    comments:
    - 'OpenDSS-only (N/A): co-generation mode flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  idle:
    name: idle
    annotations:
      order:
        tag: order
        value: 33
    description: '{Yes|No*} Default is No. If Yes, disables tap changing.'
    comments:
    - 'OpenDSS-only (N/A): idle/disable tap changing mode; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  idleReverse:
    name: idleReverse
    annotations:
      order:
        tag: order
        value: 34
    description: '{Yes|No*} Default is No. If Yes, disables tap changing in reverse
      mode.'
    comments:
    - 'OpenDSS-only (N/A): reverse idle mode; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  idleForward:
    name: idleForward
    annotations:
      order:
        tag: order
        value: 35
    description: '{Yes|No*} Default is No. If Yes, disables tap changing in forward
      mode.'
    comments:
    - 'OpenDSS-only (N/A): forward idle mode; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    rank: 1000
    owner: Regcontrol
    domain_of:
    - Regcontrol
    range: boolean
    required: false
  basefreq:
    name: basefreq
    annotations:
      order:
        tag: order
        value: 36
    description: Base Frequency for ratings.
    comments:
    - Not stored on CIM TapChangerControl or RatioTapChanger; base frequency is a
      circuit-level property.
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    owner: Regcontrol
    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
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: float
    required: false
  enabled:
    name: enabled
    annotations:
      order:
        tag: order
        value: 37
    description: '{Yes|No or True|False} Indicates whether this element is enabled.'
    comments:
    - 'Import: if enabled=No, the whole Regcontrol is skipped and no CIM objects are
      created; otherwise RatioTapChanger.controlEnabled = enabled (SSH attribute;
      also RatioTapChanger.ltcFlag is always set True, since OpenDSS regulators are
      load-tap-changing). Export: enabled = controlEnabled; when controlEnabled is
      False, maxtapchange is also written as 0 (see maxtapchange comments) so OpenDSS
      holds the tap at its imported position instead of re-regulating.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    exact_mappings:
    - cim:TapChanger.controlEnabled
    owner: Regcontrol
    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
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: boolean
    required: false
  like:
    name: like
    annotations:
      order:
        tag: order
        value: 38
    description: 'Make like another object, e.g.: New Regcontrol.RC2 like=RC1 ...'
    comments:
    - 'OpenDSS-only (N/A): DSS template/copy directive resolved at parse time; no
      CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/regcontrol
    owner: Regcontrol
    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:Regcontrol