Class: TapChangerControl

name: TapChangerControl
description: Describes behaviour specific to tap changers, e.g. how the voltage at
  the end of a line varies with the load level and compensation of the voltage drop
  by tap adjustment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: RegulatingControl
attributes:
  limit_voltage:
    name: limit_voltage
    description: "Maximum allowed regulated voltage on the PT secondary, regardless\
      \ of line drop compensation. Sometimes referred to as first-house protection.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.limitVoltage
    multivalued: false
    domain_of:
    - TapChangerControl
    range: Voltage
    required: false
  line_drop_compensation:
    name: line_drop_compensation
    description: If true, the line drop compensation is to be applied.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.lineDropCompensation
    multivalued: false
    domain_of:
    - TapChangerControl
    range: boolean
    required: false
  line_drop_r:
    name: line_drop_r
    description: Line drop compensator resistance setting for normal (forward) power
      flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.lineDropR
    multivalued: false
    domain_of:
    - TapChangerControl
    range: Resistance
    required: false
  line_drop_x:
    name: line_drop_x
    description: Line drop compensator reactance setting for normal (forward) power
      flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.lineDropX
    multivalued: false
    domain_of:
    - TapChangerControl
    range: Reactance
    required: false
  reverse_line_drop_r:
    name: reverse_line_drop_r
    description: Line drop compensator resistance setting for reverse power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.reverseLineDropR
    multivalued: false
    domain_of:
    - TapChangerControl
    range: Resistance
    required: false
  reverse_line_drop_x:
    name: reverse_line_drop_x
    description: Line drop compensator reactance setting for reverse power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.reverseLineDropX
    multivalued: false
    domain_of:
    - TapChangerControl
    range: Reactance
    required: false
  tap_changer:
    name: tap_changer
    description: The tap changers that participates in this regulating tap control
      scheme.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TapChangerControl.TapChanger
    multivalued: true
    domain_of:
    - SvTapStep
    - TapSchedule
    - TapChangerControl
    range: TapChanger
    required: true
class_uri: cim:TapChangerControl

name: TapChangerControl
description: Describes behaviour specific to tap changers, e.g. how the voltage at
  the end of a line varies with the load level and compensation of the voltage drop
  by tap adjustment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: RegulatingControl
attributes:
  limit_voltage:
    name: limit_voltage
    description: "Maximum allowed regulated voltage on the PT secondary, regardless\
      \ of line drop compensation. Sometimes referred to as first-house protection.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.limitVoltage
    multivalued: false
    alias: limit_voltage
    owner: TapChangerControl
    domain_of:
    - TapChangerControl
    range: Voltage
    required: false
  line_drop_compensation:
    name: line_drop_compensation
    description: If true, the line drop compensation is to be applied.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.lineDropCompensation
    multivalued: false
    alias: line_drop_compensation
    owner: TapChangerControl
    domain_of:
    - TapChangerControl
    range: boolean
    required: false
  line_drop_r:
    name: line_drop_r
    description: Line drop compensator resistance setting for normal (forward) power
      flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.lineDropR
    multivalued: false
    alias: line_drop_r
    owner: TapChangerControl
    domain_of:
    - TapChangerControl
    range: Resistance
    required: false
  line_drop_x:
    name: line_drop_x
    description: Line drop compensator reactance setting for normal (forward) power
      flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.lineDropX
    multivalued: false
    alias: line_drop_x
    owner: TapChangerControl
    domain_of:
    - TapChangerControl
    range: Reactance
    required: false
  reverse_line_drop_r:
    name: reverse_line_drop_r
    description: Line drop compensator resistance setting for reverse power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.reverseLineDropR
    multivalued: false
    alias: reverse_line_drop_r
    owner: TapChangerControl
    domain_of:
    - TapChangerControl
    range: Resistance
    required: false
  reverse_line_drop_x:
    name: reverse_line_drop_x
    description: Line drop compensator reactance setting for reverse power flow.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChangerControl.reverseLineDropX
    multivalued: false
    alias: reverse_line_drop_x
    owner: TapChangerControl
    domain_of:
    - TapChangerControl
    range: Reactance
    required: false
  tap_changer:
    name: tap_changer
    description: The tap changers that participates in this regulating tap control
      scheme.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TapChangerControl.TapChanger
    multivalued: true
    alias: tap_changer
    owner: TapChangerControl
    domain_of:
    - SvTapStep
    - TapSchedule
    - TapChangerControl
    range: TapChanger
    required: true
  discrete:
    name: discrete
    description: The regulation is performed in a discrete mode. This applies to equipment
      with discrete controls, e.g. tap changers and shunt compensators.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegulatingControl.discrete
    multivalued: false
    alias: discrete
    owner: TapChangerControl
    domain_of:
    - RegulatingControl
    - DiscreteValue
    range: boolean
    required: false
  enabled:
    name: enabled
    description: The flag tells if regulation is enabled.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:RegulatingControl.enabled
    multivalued: false
    alias: enabled
    owner: TapChangerControl
    domain_of:
    - ProtectiveAction
    - EndDeviceFunction
    - RegulatingControl
    - DynamicsFunctionBlock
    range: boolean
    required: false
  max_allowed_target_value:
    name: max_allowed_target_value
    description: Maximum allowed target value (RegulatingControl.targetValue).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegulatingControl.maxAllowedTargetValue
    multivalued: false
    alias: max_allowed_target_value
    owner: TapChangerControl
    domain_of:
    - RegulatingControl
    range: float
    required: false
  min_allowed_target_value:
    name: min_allowed_target_value
    description: "Minimum allowed target value (RegulatingControl.targetValue).\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegulatingControl.minAllowedTargetValue
    multivalued: false
    alias: min_allowed_target_value
    owner: TapChangerControl
    domain_of:
    - RegulatingControl
    range: float
    required: false
  mode:
    name: mode
    description: The regulating control mode presently available.  This specification
      allows for determining the kind of regulation without need for obtaining the
      units from a schedule.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegulatingControl.mode
    multivalued: false
    alias: mode
    owner: TapChangerControl
    domain_of:
    - RegulatingControl
    - PetersenCoil
    range: RegulatingControlModeKind
    required: false
  monitored_phase:
    name: monitored_phase
    description: Phase voltage controlling this regulator, measured at regulator location.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegulatingControl.monitoredPhase
    multivalued: false
    alias: monitored_phase
    owner: TapChangerControl
    domain_of:
    - RegulatingControl
    range: PhaseCode
    required: false
  target_deadband:
    name: target_deadband
    description: "This is a deadband used with discrete control to avoid excessive\
      \ update of controls like tap changers and shunt compensator banks while regulating.\
      \  The units of those appropriate for the mode. The attribute shall be a positive\
      \ value or zero. If RegulatingControl.discrete is set to \"false\", the RegulatingControl.targetDeadband\
      \ is to be ignored.\r\nNote that for instance, if the targetValue is 100 kV\
      \ and the targetDeadband is 2 kV the range is from 99 to 101 kV."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegulatingControl.targetDeadband
    multivalued: false
    alias: target_deadband
    owner: TapChangerControl
    domain_of:
    - RegulatingControl
    range: float
    required: false
  target_value:
    name: target_value
    description: The target value specified for case input.   This value can be used
      for the target value without the use of schedules. The value has the units appropriate
      to the mode attribute.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegulatingControl.targetValue
    multivalued: false
    alias: target_value
    owner: TapChangerControl
    domain_of:
    - RegulatingControl
    - ProtectiveActionRegulation
    range: float
    required: false
  target_value_unit_multiplier:
    name: target_value_unit_multiplier
    description: Specify the multiplier for used for the targetValue.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegulatingControl.targetValueUnitMultiplier
    multivalued: false
    alias: target_value_unit_multiplier
    owner: TapChangerControl
    domain_of:
    - RegulatingControl
    range: UnitMultiplier
    required: false
  regulating_cond_eq:
    name: regulating_cond_eq
    description: The equipment that participates in this regulating control scheme.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegulatingControl.RegulatingCondEq
    multivalued: true
    alias: regulating_cond_eq
    owner: TapChangerControl
    domain_of:
    - RegulatingControl
    range: RegulatingCondEq
    required: false
  regulation_schedule:
    name: regulation_schedule
    description: Schedule for this regulating control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegulatingControl.RegulationSchedule
    multivalued: true
    alias: regulation_schedule
    owner: TapChangerControl
    domain_of:
    - RegulatingControl
    - VoltageControlZone
    range: RegulationSchedule
    required: false
  terminal:
    name: terminal
    description: 'The terminal associated with this regulating control.  The terminal
      is associated instead of a node, since the terminal could connect into either
      a topological node or a connectivity node.  Sometimes it is useful to model
      regulation at a terminal of a bus bar object. '
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:RegulatingControl.Terminal
    multivalued: false
    alias: terminal
    owner: TapChangerControl
    domain_of:
    - BusNameMarker
    - OperationalLimitSet
    - TopologicalNode
    - TransformerEnd
    - Measurement
    - Bushing
    - TieFlow
    - SvPowerFlow
    - RegulatingControl
    - RemoteInputSignal
    - BranchGroupTerminal
    - AuxiliaryEquipment
    - EquipmentFault
    - PinTerminal
    range: Terminal
    required: false
  protective_action_regulation:
    name: protective_action_regulation
    description: Enable/disable a regulating control or set new target value.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegulatingControl.ProtectiveActionRegulation
    multivalued: true
    alias: protective_action_regulation
    owner: TapChangerControl
    domain_of:
    - RegulatingControl
    range: ProtectiveActionRegulation
    required: false
  controls:
    name: controls
    description: The controller outputs used to actually govern a regulating device,
      e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.Controls
    multivalued: true
    alias: controls
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    - HostControlArea
    range: Control
    required: false
  measurements:
    name: measurements
    description: The measurements associated with this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.Measurements
    multivalued: true
    alias: measurements
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    - ACDCTerminal
    - Asset
    - Location
    - Procedure
    - AnalogLimitSet
    - AccumulatorLimitSet
    range: Measurement
    required: false
  psrtype:
    name: psrtype
    description: Custom classification for this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.PSRType
    multivalued: false
    alias: psrtype
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    range: PSRType
    required: false
  configuration_event:
    name: configuration_event
    description: All configuration events created for this Power System resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.ConfigurationEvent
    multivalued: true
    alias: configuration_event
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    - FaultCauseType
    range: ConfigurationEvent
    required: false
  reporting_group:
    name: reporting_group
    description: Reporting groups to which this power system resource belongs.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.ReportingGroup
    multivalued: true
    alias: reporting_group
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    - BusNameMarker
    - TopologicalNode
    - ReportingSuperGroup
    range: ReportingGroup
    required: false
  operating_share:
    name: operating_share
    description: The operating shares of this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.OperatingShare
    multivalued: true
    alias: operating_share
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    - OperatingParticipant
    range: OperatingShare
    required: false
  asset_datasheet:
    name: asset_datasheet
    description: Datasheet information for this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.AssetDatasheet
    multivalued: false
    alias: asset_datasheet
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    range: AssetInfo
    required: false
  verification_action:
    name: verification_action
    description: The verification action that is performed on the power system resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.VerificationAction
    multivalued: true
    alias: verification_action
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    range: VerificationAction
    required: false
  clearances:
    name: clearances
    description: All clearances applicable to this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.Clearances
    multivalued: true
    alias: clearances
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    range: ClearanceDocument
    required: false
  generic_action:
    name: generic_action
    description: The generic action that is performed on the power system resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.GenericAction
    multivalued: true
    alias: generic_action
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    range: GenericAction
    required: false
  psrevents:
    name: psrevents
    description: All events associated with this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.PSREvents
    multivalued: true
    alias: psrevents
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    range: PSREvent
    required: false
  assets:
    name: assets
    description: All assets represented by this power system resource. For example,
      multiple conductor assets are electrically modelled as a single AC line segment.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.Assets
    multivalued: true
    alias: assets
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    - AssetInfo
    - Location
    - WorkTask
    - ErpRecDelvLineItem
    - AssetContainer
    - ActivityRecord
    - Procedure
    - ReliabilityInfo
    - AssetPropertyCurve
    - AssetOrganisationRole
    - ScheduledEvent
    range: Asset
    required: false
  location:
    name: location
    description: Location of this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.Location
    multivalued: false
    alias: location
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    - Asset
    - Incident
    - SwitchingOrder
    - TroubleOrder
    - Crew
    - Fault
    - PointOfSale
    - TroubleTicket
    - OutageOrder
    - EnvironmentalMonitoringStation
    - EnvironmentalLocationType
    - PositionPoint
    - FailureEvent
    range: Location
    required: false
  operational_tags:
    name: operational_tags
    description: All operational tags placed on this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PowerSystemResource.OperationalTags
    multivalued: true
    alias: operational_tags
    owner: TapChangerControl
    domain_of:
    - PowerSystemResource
    - Asset
    range: OperationalTag
    required: false
  alias_name:
    name: alias_name
    description: "The aliasName is free text human readable name of the object alternative\
      \ to IdentifiedObject.name. It may be non unique and may not correlate to a\
      \ naming hierarchy.\r\nThe attribute aliasName is retained because of backwards\
      \ compatibility between CIM relases. It is however recommended to replace aliasName\
      \ with the Name class as aliasName is planned for retirement at a future time.\r\
      \n\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.aliasName
    multivalued: false
    alias: alias_name
    owner: TapChangerControl
    domain_of:
    - IdentifiedObject
    range: string
    required: false
  description:
    name: description
    description: The description is a free human readable text describing or naming
      the object. It may be non unique and may not correlate to a naming hierarchy.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.description
    multivalued: false
    alias: description
    owner: TapChangerControl
    domain_of:
    - IdentifiedObject
    - NameType
    - NameTypeAuthority
    - DataSet
    - SwitchingStepGroup
    - AreaReserveSpec
    range: string
    required: false
  m_rid:
    name: m_rid
    description: "Master resource identifier issued by a model authority. The mRID\
      \ is unique within an exchange context. Global uniqueness is easily achieved\
      \ by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is\
      \ strongly recommended.\r\nFor CIMXML data files in RDF syntax conforming to\
      \ IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify\
      \ CIM object elements."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.mRID
    multivalued: false
    alias: m_rid
    owner: TapChangerControl
    domain_of:
    - IdentifiedObject
    - DataSet
    range: string
    required: false
  diagram_objects:
    name: diagram_objects
    description: The diagram objects that are associated with the domain object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.DiagramObjects
    multivalued: true
    alias: diagram_objects
    owner: TapChangerControl
    domain_of:
    - IdentifiedObject
    range: DiagramObject
    required: false
  instance_set:
    name: instance_set
    description: Dataset containing the data objects.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.InstanceSet
    multivalued: false
    alias: instance_set
    owner: TapChangerControl
    domain_of:
    - IdentifiedObject
    range: InstanceSet
    required: true
  names:
    name: names
    description: All names of this identified object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.Names
    multivalued: true
    alias: names
    owner: TapChangerControl
    domain_of:
    - IdentifiedObject
    - NameType
    range: Name
    required: false
  properties_cimdata_object:
    name: properties_cimdata_object
    description: The single CIM data object in the appropriate dataset context.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.PropertiesCIMDataObject
    multivalued: false
    alias: properties_cimdata_object
    owner: TapChangerControl
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
  targeting_cimdata_object:
    name: targeting_cimdata_object
    description: Data objects registered.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.TargetingCIMDataObject
    multivalued: true
    alias: targeting_cimdata_object
    owner: TapChangerControl
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:TapChangerControl