Class: Capcontrol

A Capcontrol object in OpenDSS representing a capacitor bank control that monitors a line or transformer and switches the capacitor ON or OFF.

URI: dss:Capcontrol

 classDiagram
    class Capcontrol
    click Capcontrol href "../Capcontrol/"
      Capcontrol : basefreq

      Capcontrol : capacitor

      Capcontrol : ControlSignal

      Capcontrol : CTPhase

      Capcontrol : CTratio

      Capcontrol : DeadTime

      Capcontrol : Delay

      Capcontrol : DelayOFF

      Capcontrol : element

      Capcontrol : enabled

      Capcontrol : EventLog

      Capcontrol : like

      Capcontrol : name

      Capcontrol : OFFsetting

      Capcontrol : ONsetting

      Capcontrol : pctMinkvar

      Capcontrol : PTPhase

      Capcontrol : PTratio

      Capcontrol : Reset

      Capcontrol : terminal

      Capcontrol : type

      Capcontrol : UserData

      Capcontrol : UserModel

      Capcontrol : VBus

      Capcontrol : Vmax

      Capcontrol : Vmin

      Capcontrol : VoltOverride

Class Properties

Property	Value
Class URI	dss:Capcontrol

Slots

Name	Cardinality and Range	Description	Inheritance
name	1 String	Object name	direct
element	0..1 String	Full object name of the circuit element (typically a line or transformer) to ...	direct
terminal	0..1 Integer	Number of the terminal of the circuit element to which the CapControl is conn...	direct
capacitor	0..1 String	Name of Capacitor element which the CapControl controls	direct
type	0..1 String	{Current	voltage
PTratio	0..1 Float	Ratio of the PT that converts the monitored voltage to the control voltage	direct
CTratio	0..1 Float	Ratio of the CT from line amps to control ampere setting for current and kvar...	direct
ONsetting	0..1 Float	Value at which the control arms to switch the capacitor ON (or ratchet up a s...	direct
OFFsetting	0..1 String	Value at which the control arms to switch the capacitor OFF	direct
Delay	0..1 String	Time delay, in seconds, from when the control is armed before it sends the sw...	direct
VoltOverride	0..1 Boolean	{Yes	No} Default is No
Vmax	0..1 Float	Maximum voltage, in volts, above which control is forced ON regardless of con...	direct
Vmin	0..1 Float	Minimum voltage, in volts, below which control is forced OFF regardless of co...	direct
DelayOFF	0..1 String	Time delay, in seconds, for control to turn OFF when present state is ON	direct
DeadTime	0..1 String	Dead time after capacitor is turned OFF before it can be turned back ON	direct
CTPhase	0..1 Integer	Number of the phase being monitored for CURRENT control or one of {AVG	MAX ...
PTPhase	0..1 Integer	Number of the phase being monitored for VOLTAGE control or one of {AVG	MAX ...
VBus	0..1 Float	Name of bus to use for voltage override function	direct
EventLog	0..1 String	{Yes/True*	No/False} Default is YES for CapControl
UserModel	0..1 String	Name of DLL containing user-written CapControl model	direct
UserData	0..1 String	String that gets passed to the user-written CapControl model	direct
pctMinkvar	0..1 Float	For PF control option, min percent of total bank kvar at which control will c...	direct
Reset	0..1 Boolean	{Yes	No} If Yes, forces Reset of this CapControl
ControlSignal	0..1 String	Name of the load shape used for controlling the connection/disconnection of t...	direct
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

• OpenDSS Capcontrol maps to CIM RegulatingControl. The monitored element Terminal is set as RegulatingControl.Terminal, and the controlled LinearShuntCompensator is set as RegulatingControl.RegulatingCondEq.

Identifier and Mapping Information

Schema Source

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

Mappings

Mapping Type	Mapped Value
self	dss:Capcontrol
native	dss:Capcontrol
exact	cim:RegulatingControl

LinkML Source

Direct

name: Capcontrol
description: A Capcontrol object in OpenDSS representing a capacitor bank control
  that monitors a line or transformer and switches the capacitor ON or OFF.
comments:
- OpenDSS Capcontrol maps to CIM RegulatingControl. The monitored element Terminal
  is set as RegulatingControl.Terminal, and the controlled LinearShuntCompensator
  is set as RegulatingControl.RegulatingCondEq.
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:RegulatingControl
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/controls/capcontrol
    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
  element:
    name: element
    annotations:
      order:
        tag: order
        value: 1
    description: Full object name of the circuit element (typically a line or transformer)
      to which the capacitor control's PT and/or CT are connected.
    comments:
    - 'Import: resolved to a Terminal on the named element; RegulatingControl.Terminal
      = that terminal. Export: element = Terminal.ConductingEquipment.name.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    related_mappings:
    - cim:RegulatingControl.Terminal
    rank: 1000
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: string
    required: false
  terminal:
    name: terminal
    annotations:
      order:
        tag: order
        value: 2
    description: Number of the terminal of the circuit element to which the CapControl
      is connected. Default is 1.
    comments:
    - 'Import: selects terminal index (1-based) on the monitored element for RegulatingControl.Terminal.
      Export: terminal = index of RegulatingControl.Terminal.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    related_mappings:
    - cim:RegulatingControl.Terminal
    rank: 1000
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: integer
    required: false
  capacitor:
    name: capacitor
    annotations:
      order:
        tag: order
        value: 3
    description: Name of Capacitor element which the CapControl controls.
    comments:
    - 'Import: resolved to a LinearShuntCompensator by name; RegulatingControl.RegulatingCondEq
      = that object. Export: capacitor = RegulatingCondEq.name.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    related_mappings:
    - cim:RegulatingControl.RegulatingCondEq
    rank: 1000
    domain_of:
    - Capcontrol
    range: string
    required: false
  type:
    name: type
    annotations:
      order:
        tag: order
        value: 4
    description: '{Current | voltage | kvar | PF | time | Follow} Control type. Default
      is current.'
    comments:
    - 'Import: ''voltage'' → RegulatingControlModeKind.voltage; ''current'' → currentFlow;
      ''kvar'' → reactivePower; ''PF'' → powerFactor; ''time'' → timeScheduled. Export:
      reverse enum lookup.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.mode
    rank: 1000
    domain_of:
    - Capcontrol
    - Relay
    range: string
    required: false
  PTratio:
    name: PTratio
    annotations:
      order:
        tag: order
        value: 5
    description: Ratio of the PT that converts the monitored voltage to the control
      voltage. Default is 60.
    comments:
    - 'Import: RegulatingControl.ptRatio = PTratio. Export: PTratio = ptRatio.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.ptRatio
    rank: 1000
    domain_of:
    - Capcontrol
    range: float
    required: false
    minimum_value: 0.0
  CTratio:
    name: CTratio
    annotations:
      order:
        tag: order
        value: 6
    description: Ratio of the CT from line amps to control ampere setting for current
      and kvar control types. Default is 60.
    comments:
    - 'Import: RegulatingControl.ctRatio = CTratio. Export: CTratio = ctRatio.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.ctRatio
    rank: 1000
    domain_of:
    - Capcontrol
    range: float
    required: false
    minimum_value: 0.0
  ONsetting:
    name: ONsetting
    annotations:
      order:
        tag: order
        value: 7
      dss_name:
        tag: dss_name
        value: 'on'
    description: Value at which the control arms to switch the capacitor ON (or ratchet
      up a step). Default is 300 amps.
    comments:
    - 'Import: RegulatingControl.targetValue = ONsetting. Export: ONsetting = targetValue.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.targetValue
    rank: 1000
    domain_of:
    - Capcontrol
    range: float
    required: false
  OFFsetting:
    name: OFFsetting
    annotations:
      order:
        tag: order
        value: 8
      dss_name:
        tag: dss_name
        value: 'off'
    description: Value at which the control arms to switch the capacitor OFF. Default
      is 200 amps.
    comments:
    - 'Import: RegulatingControl.targetDeadband = ONsetting - OFFsetting (the CIM
      deadband is a half-width symmetric band around targetValue). Export: OFFsetting
      = targetValue - targetDeadband.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    close_mappings:
    - cim:RegulatingControl.targetDeadband
    rank: 1000
    domain_of:
    - Capcontrol
    range: string
    required: false
  Delay:
    name: Delay
    annotations:
      order:
        tag: order
        value: 9
    description: Time delay, in seconds, from when the control is armed before it
      sends the switching command to turn ON. Default is 15 s.
    comments:
    - 'Import: LinearShuntCompensator.aVRDelay = Delay (seconds). Export: Delay =
      aVRDelay.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:ShuntCompensator.aVRDelay
    rank: 1000
    domain_of:
    - Capcontrol
    - Fuse
    - Recloser
    - Relay
    - Swtcontrol
    range: string
    required: false
  VoltOverride:
    name: VoltOverride
    annotations:
      order:
        tag: order
        value: 10
    description: '{Yes | No}  Default is No. If Yes, enables the VoltOverride feature
      using Vmax and Vmin limits.'
    comments:
    - 'OpenDSS-only (N/A): flag enabling the voltage override feature; no clean CIM
      mapping. Vmax/Vmin carry the actual limit values.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    domain_of:
    - Capcontrol
    range: boolean
    required: false
  Vmax:
    name: Vmax
    annotations:
      order:
        tag: order
        value: 11
    description: Maximum voltage, in volts, above which control is forced ON regardless
      of control type setting.
    comments:
    - 'Import: RegulatingControl.maxAllowedTargetValue = Vmax. Export: Vmax = maxAllowedTargetValue.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.maxAllowedTargetValue
    rank: 1000
    domain_of:
    - Capcontrol
    range: float
    required: false
  Vmin:
    name: Vmin
    annotations:
      order:
        tag: order
        value: 12
    description: Minimum voltage, in volts, below which control is forced OFF regardless
      of control type setting.
    comments:
    - 'Import: RegulatingControl.minAllowedTargetValue = Vmin. Export: Vmin = minAllowedTargetValue.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.minAllowedTargetValue
    rank: 1000
    domain_of:
    - Capcontrol
    range: float
    required: false
  DelayOFF:
    name: DelayOFF
    annotations:
      order:
        tag: order
        value: 13
    description: Time delay, in seconds, for control to turn OFF when present state
      is ON. Default is 15 s.
    comments:
    - 'OpenDSS-only (N/A): asymmetric OFF delay; no CIM equivalent distinguishing
      ON vs OFF delay in RegulatingControl.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    domain_of:
    - Capcontrol
    range: string
    required: false
  DeadTime:
    name: DeadTime
    annotations:
      order:
        tag: order
        value: 14
    description: Dead time after capacitor is turned OFF before it can be turned back
      ON. Default is 300 s.
    comments:
    - 'OpenDSS-only (N/A): re-close inhibit timer; no direct CIM equivalent in the
      standard profile.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    domain_of:
    - Capcontrol
    range: string
    required: false
  CTPhase:
    name: CTPhase
    annotations:
      order:
        tag: order
        value: 15
    description: Number of the phase being monitored for CURRENT control or one of
      {AVG | MAX | MIN} for all phases. Default is 1.
    comments:
    - 'OpenDSS-only (N/A): CT monitoring phase selector; no direct CIM equivalent
      on RegulatingControl.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    domain_of:
    - Capcontrol
    range: integer
    required: false
  PTPhase:
    name: PTPhase
    annotations:
      order:
        tag: order
        value: 16
    description: Number of the phase being monitored for VOLTAGE control or one of
      {AVG | MAX | MIN} for all phases. Default is 1.
    comments:
    - 'Import: RegulatingControl.monitoredPhase set from PTPhase. Export: PTPhase
      from monitoredPhase.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.monitoredPhase
    rank: 1000
    domain_of:
    - Capcontrol
    range: integer
    required: false
  VBus:
    name: VBus
    annotations:
      order:
        tag: order
        value: 17
    description: Name of bus to use for voltage override function. Defaults to monitored
      element bus.
    comments:
    - 'OpenDSS-only (N/A): alternate monitoring bus for voltage override; no direct
      CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    domain_of:
    - Capcontrol
    range: float
    required: false
  EventLog:
    name: EventLog
    annotations:
      order:
        tag: order
        value: 18
    description: '{Yes/True* | No/False} Default is YES for CapControl. If Yes, writes
      switching events to a log.'
    comments:
    - 'OpenDSS-only (N/A): debug logging flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    domain_of:
    - Capcontrol
    - Expcontrol
    - Invcontrol
    - Regcontrol
    - Relay
    - Storagecontroller
    range: string
    required: false
  UserModel:
    name: UserModel
    annotations:
      order:
        tag: order
        value: 19
    description: Name of DLL containing user-written CapControl model.
    comments:
    - 'OpenDSS-only (N/A): user model DLL hook; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    domain_of:
    - Generator
    - Pvsystem
    - Storage
    - Windgen
    - Capcontrol
    range: string
    required: false
  UserData:
    name: UserData
    annotations:
      order:
        tag: order
        value: 20
    description: String that gets passed to the user-written CapControl model.
    comments:
    - 'OpenDSS-only (N/A): user model data; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    domain_of:
    - Generator
    - Pvsystem
    - Storage
    - Windgen
    - Capcontrol
    range: string
    required: false
  pctMinkvar:
    name: pctMinkvar
    annotations:
      order:
        tag: order
        value: 21
    description: For PF control option, min percent of total bank kvar at which control
      will close capacitor switch. Default is 50.
    comments:
    - 'OpenDSS-only (N/A): PF control deadband parameter; no direct CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    domain_of:
    - Capcontrol
    range: float
    required: false
  Reset:
    name: Reset
    annotations:
      order:
        tag: order
        value: 22
    description: '{Yes | No} If Yes, forces Reset of this CapControl.'
    comments:
    - 'OpenDSS-only (N/A): operational reset flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    domain_of:
    - Capcontrol
    - Recloser
    - Regcontrol
    - Relay
    - Swtcontrol
    range: boolean
    required: false
  ControlSignal:
    name: ControlSignal
    annotations:
      order:
        tag: order
        value: 23
    description: Name of the load shape used for controlling the connection/disconnection
      of the capacitor to the grid.
    todos:
    - Loadshape converter not yet implemented. ControlSignal LoadShape reference should
      map to a CIM SeasonDayTypeSchedule.
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    related_mappings:
    - cim:SeasonDayTypeSchedule
    rank: 1000
    domain_of:
    - Capcontrol
    range: string
    required: false
  basefreq:
    name: basefreq
    annotations:
      order:
        tag: order
        value: 24
    description: Base Frequency for ratings.
    comments:
    - Not stored on CIM RegulatingControl; base frequency is a circuit-level property
      in CIM.
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    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: 25
    description: '{Yes|No or True|False} Indicates whether this element is enabled.'
    comments:
    - 'Import: RegulatingControl.enabled = enabled. Export: enabled from RegulatingControl.enabled.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.enabled
    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: 26
    description: 'Make like another object, e.g.: New Capcontrol.CC2 like=CC1 ...'
    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/capcontrol
    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:Capcontrol

Induced

name: Capcontrol
description: A Capcontrol object in OpenDSS representing a capacitor bank control
  that monitors a line or transformer and switches the capacitor ON or OFF.
comments:
- OpenDSS Capcontrol maps to CIM RegulatingControl. The monitored element Terminal
  is set as RegulatingControl.Terminal, and the controlled LinearShuntCompensator
  is set as RegulatingControl.RegulatingCondEq.
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:RegulatingControl
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/controls/capcontrol
    exact_mappings:
    - cim:IdentifiedObject.name
    identifier: true
    owner: Capcontrol
    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
  element:
    name: element
    annotations:
      order:
        tag: order
        value: 1
    description: Full object name of the circuit element (typically a line or transformer)
      to which the capacitor control's PT and/or CT are connected.
    comments:
    - 'Import: resolved to a Terminal on the named element; RegulatingControl.Terminal
      = that terminal. Export: element = Terminal.ConductingEquipment.name.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    related_mappings:
    - cim:RegulatingControl.Terminal
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: string
    required: false
  terminal:
    name: terminal
    annotations:
      order:
        tag: order
        value: 2
    description: Number of the terminal of the circuit element to which the CapControl
      is connected. Default is 1.
    comments:
    - 'Import: selects terminal index (1-based) on the monitored element for RegulatingControl.Terminal.
      Export: terminal = index of RegulatingControl.Terminal.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    related_mappings:
    - cim:RegulatingControl.Terminal
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: integer
    required: false
  capacitor:
    name: capacitor
    annotations:
      order:
        tag: order
        value: 3
    description: Name of Capacitor element which the CapControl controls.
    comments:
    - 'Import: resolved to a LinearShuntCompensator by name; RegulatingControl.RegulatingCondEq
      = that object. Export: capacitor = RegulatingCondEq.name.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    related_mappings:
    - cim:RegulatingControl.RegulatingCondEq
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: string
    required: false
  type:
    name: type
    annotations:
      order:
        tag: order
        value: 4
    description: '{Current | voltage | kvar | PF | time | Follow} Control type. Default
      is current.'
    comments:
    - 'Import: ''voltage'' → RegulatingControlModeKind.voltage; ''current'' → currentFlow;
      ''kvar'' → reactivePower; ''PF'' → powerFactor; ''time'' → timeScheduled. Export:
      reverse enum lookup.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.mode
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    - Relay
    range: string
    required: false
  PTratio:
    name: PTratio
    annotations:
      order:
        tag: order
        value: 5
    description: Ratio of the PT that converts the monitored voltage to the control
      voltage. Default is 60.
    comments:
    - 'Import: RegulatingControl.ptRatio = PTratio. Export: PTratio = ptRatio.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.ptRatio
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: float
    required: false
    minimum_value: 0.0
  CTratio:
    name: CTratio
    annotations:
      order:
        tag: order
        value: 6
    description: Ratio of the CT from line amps to control ampere setting for current
      and kvar control types. Default is 60.
    comments:
    - 'Import: RegulatingControl.ctRatio = CTratio. Export: CTratio = ctRatio.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.ctRatio
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: float
    required: false
    minimum_value: 0.0
  ONsetting:
    name: ONsetting
    annotations:
      order:
        tag: order
        value: 7
      dss_name:
        tag: dss_name
        value: 'on'
    description: Value at which the control arms to switch the capacitor ON (or ratchet
      up a step). Default is 300 amps.
    comments:
    - 'Import: RegulatingControl.targetValue = ONsetting. Export: ONsetting = targetValue.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.targetValue
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: float
    required: false
  OFFsetting:
    name: OFFsetting
    annotations:
      order:
        tag: order
        value: 8
      dss_name:
        tag: dss_name
        value: 'off'
    description: Value at which the control arms to switch the capacitor OFF. Default
      is 200 amps.
    comments:
    - 'Import: RegulatingControl.targetDeadband = ONsetting - OFFsetting (the CIM
      deadband is a half-width symmetric band around targetValue). Export: OFFsetting
      = targetValue - targetDeadband.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    close_mappings:
    - cim:RegulatingControl.targetDeadband
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: string
    required: false
  Delay:
    name: Delay
    annotations:
      order:
        tag: order
        value: 9
    description: Time delay, in seconds, from when the control is armed before it
      sends the switching command to turn ON. Default is 15 s.
    comments:
    - 'Import: LinearShuntCompensator.aVRDelay = Delay (seconds). Export: Delay =
      aVRDelay.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:ShuntCompensator.aVRDelay
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    - Fuse
    - Recloser
    - Relay
    - Swtcontrol
    range: string
    required: false
  VoltOverride:
    name: VoltOverride
    annotations:
      order:
        tag: order
        value: 10
    description: '{Yes | No}  Default is No. If Yes, enables the VoltOverride feature
      using Vmax and Vmin limits.'
    comments:
    - 'OpenDSS-only (N/A): flag enabling the voltage override feature; no clean CIM
      mapping. Vmax/Vmin carry the actual limit values.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: boolean
    required: false
  Vmax:
    name: Vmax
    annotations:
      order:
        tag: order
        value: 11
    description: Maximum voltage, in volts, above which control is forced ON regardless
      of control type setting.
    comments:
    - 'Import: RegulatingControl.maxAllowedTargetValue = Vmax. Export: Vmax = maxAllowedTargetValue.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.maxAllowedTargetValue
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: float
    required: false
  Vmin:
    name: Vmin
    annotations:
      order:
        tag: order
        value: 12
    description: Minimum voltage, in volts, below which control is forced OFF regardless
      of control type setting.
    comments:
    - 'Import: RegulatingControl.minAllowedTargetValue = Vmin. Export: Vmin = minAllowedTargetValue.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.minAllowedTargetValue
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: float
    required: false
  DelayOFF:
    name: DelayOFF
    annotations:
      order:
        tag: order
        value: 13
    description: Time delay, in seconds, for control to turn OFF when present state
      is ON. Default is 15 s.
    comments:
    - 'OpenDSS-only (N/A): asymmetric OFF delay; no CIM equivalent distinguishing
      ON vs OFF delay in RegulatingControl.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: string
    required: false
  DeadTime:
    name: DeadTime
    annotations:
      order:
        tag: order
        value: 14
    description: Dead time after capacitor is turned OFF before it can be turned back
      ON. Default is 300 s.
    comments:
    - 'OpenDSS-only (N/A): re-close inhibit timer; no direct CIM equivalent in the
      standard profile.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: string
    required: false
  CTPhase:
    name: CTPhase
    annotations:
      order:
        tag: order
        value: 15
    description: Number of the phase being monitored for CURRENT control or one of
      {AVG | MAX | MIN} for all phases. Default is 1.
    comments:
    - 'OpenDSS-only (N/A): CT monitoring phase selector; no direct CIM equivalent
      on RegulatingControl.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: integer
    required: false
  PTPhase:
    name: PTPhase
    annotations:
      order:
        tag: order
        value: 16
    description: Number of the phase being monitored for VOLTAGE control or one of
      {AVG | MAX | MIN} for all phases. Default is 1.
    comments:
    - 'Import: RegulatingControl.monitoredPhase set from PTPhase. Export: PTPhase
      from monitoredPhase.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.monitoredPhase
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: integer
    required: false
  VBus:
    name: VBus
    annotations:
      order:
        tag: order
        value: 17
    description: Name of bus to use for voltage override function. Defaults to monitored
      element bus.
    comments:
    - 'OpenDSS-only (N/A): alternate monitoring bus for voltage override; no direct
      CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: float
    required: false
  EventLog:
    name: EventLog
    annotations:
      order:
        tag: order
        value: 18
    description: '{Yes/True* | No/False} Default is YES for CapControl. If Yes, writes
      switching events to a log.'
    comments:
    - 'OpenDSS-only (N/A): debug logging flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    - Expcontrol
    - Invcontrol
    - Regcontrol
    - Relay
    - Storagecontroller
    range: string
    required: false
  UserModel:
    name: UserModel
    annotations:
      order:
        tag: order
        value: 19
    description: Name of DLL containing user-written CapControl model.
    comments:
    - 'OpenDSS-only (N/A): user model DLL hook; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    owner: Capcontrol
    domain_of:
    - Generator
    - Pvsystem
    - Storage
    - Windgen
    - Capcontrol
    range: string
    required: false
  UserData:
    name: UserData
    annotations:
      order:
        tag: order
        value: 20
    description: String that gets passed to the user-written CapControl model.
    comments:
    - 'OpenDSS-only (N/A): user model data; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    owner: Capcontrol
    domain_of:
    - Generator
    - Pvsystem
    - Storage
    - Windgen
    - Capcontrol
    range: string
    required: false
  pctMinkvar:
    name: pctMinkvar
    annotations:
      order:
        tag: order
        value: 21
    description: For PF control option, min percent of total bank kvar at which control
      will close capacitor switch. Default is 50.
    comments:
    - 'OpenDSS-only (N/A): PF control deadband parameter; no direct CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: float
    required: false
  Reset:
    name: Reset
    annotations:
      order:
        tag: order
        value: 22
    description: '{Yes | No} If Yes, forces Reset of this CapControl.'
    comments:
    - 'OpenDSS-only (N/A): operational reset flag; no CIM equivalent.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    - Recloser
    - Regcontrol
    - Relay
    - Swtcontrol
    range: boolean
    required: false
  ControlSignal:
    name: ControlSignal
    annotations:
      order:
        tag: order
        value: 23
    description: Name of the load shape used for controlling the connection/disconnection
      of the capacitor to the grid.
    todos:
    - Loadshape converter not yet implemented. ControlSignal LoadShape reference should
      map to a CIM SeasonDayTypeSchedule.
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    related_mappings:
    - cim:SeasonDayTypeSchedule
    rank: 1000
    owner: Capcontrol
    domain_of:
    - Capcontrol
    range: string
    required: false
  basefreq:
    name: basefreq
    annotations:
      order:
        tag: order
        value: 24
    description: Base Frequency for ratings.
    comments:
    - Not stored on CIM RegulatingControl; base frequency is a circuit-level property
      in CIM.
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    owner: Capcontrol
    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: 25
    description: '{Yes|No or True|False} Indicates whether this element is enabled.'
    comments:
    - 'Import: RegulatingControl.enabled = enabled. Export: enabled from RegulatingControl.enabled.'
    from_schema: https://gridappsd.github.io/dss-graph/controls/capcontrol
    exact_mappings:
    - cim:RegulatingControl.enabled
    owner: Capcontrol
    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: 26
    description: 'Make like another object, e.g.: New Capcontrol.CC2 like=CC1 ...'
    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/capcontrol
    owner: Capcontrol
    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:Capcontrol