Class: RatioTapChanger

name: RatioTapChanger
description: "A tap changer that changes the voltage ratio impacting the voltage magnitude\
  \ but not the phase angle across the transformer.\r\n\r\nAngle sign convention (general):\
  \ Positive value indicates a positive phase shift from the winding where the tap\
  \ is located to the other winding (for a two-winding transformer)."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: TapChanger
attributes:
  step_voltage_increment:
    name: step_voltage_increment
    description: "Tap step increment, in per cent of rated voltage of the power transformer\
      \ end, per step position.\r\nWhen the increment is negative, the voltage decreases\
      \ when the tap step increases."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RatioTapChanger.stepVoltageIncrement
    multivalued: false
    domain_of:
    - RatioTapChanger
    - TapChangerInfo
    range: PerCent
    required: false
  tcul_control_mode:
    name: tcul_control_mode
    description: Specifies the regulation control mode (voltage or reactive) of the
      RatioTapChanger.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RatioTapChanger.tculControlMode
    multivalued: false
    domain_of:
    - RatioTapChanger
    range: TransformerControlMode
    required: false
  ratio_tap_changer_table:
    name: ratio_tap_changer_table
    description: The tap ratio table for this ratio  tap changer.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RatioTapChanger.RatioTapChangerTable
    multivalued: false
    domain_of:
    - RatioTapChanger
    - RatioTapChangerTablePoint
    range: RatioTapChangerTable
    required: false
  transformer_end:
    name: transformer_end
    description: Transformer end to which this ratio tap changer belongs.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:RatioTapChanger.TransformerEnd
    multivalued: false
    domain_of:
    - Terminal
    - TransformerStarImpedance
    - TransformerCoreAdmittance
    - PhaseTapChanger
    - RatioTapChanger
    range: TransformerEnd
    required: true
class_uri: cim:RatioTapChanger

name: RatioTapChanger
description: "A tap changer that changes the voltage ratio impacting the voltage magnitude\
  \ but not the phase angle across the transformer.\r\n\r\nAngle sign convention (general):\
  \ Positive value indicates a positive phase shift from the winding where the tap\
  \ is located to the other winding (for a two-winding transformer)."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: TapChanger
attributes:
  step_voltage_increment:
    name: step_voltage_increment
    description: "Tap step increment, in per cent of rated voltage of the power transformer\
      \ end, per step position.\r\nWhen the increment is negative, the voltage decreases\
      \ when the tap step increases."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RatioTapChanger.stepVoltageIncrement
    multivalued: false
    alias: step_voltage_increment
    owner: RatioTapChanger
    domain_of:
    - RatioTapChanger
    - TapChangerInfo
    range: PerCent
    required: false
  tcul_control_mode:
    name: tcul_control_mode
    description: Specifies the regulation control mode (voltage or reactive) of the
      RatioTapChanger.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RatioTapChanger.tculControlMode
    multivalued: false
    alias: tcul_control_mode
    owner: RatioTapChanger
    domain_of:
    - RatioTapChanger
    range: TransformerControlMode
    required: false
  ratio_tap_changer_table:
    name: ratio_tap_changer_table
    description: The tap ratio table for this ratio  tap changer.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RatioTapChanger.RatioTapChangerTable
    multivalued: false
    alias: ratio_tap_changer_table
    owner: RatioTapChanger
    domain_of:
    - RatioTapChanger
    - RatioTapChangerTablePoint
    range: RatioTapChangerTable
    required: false
  transformer_end:
    name: transformer_end
    description: Transformer end to which this ratio tap changer belongs.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:RatioTapChanger.TransformerEnd
    multivalued: false
    alias: transformer_end
    owner: RatioTapChanger
    domain_of:
    - Terminal
    - TransformerStarImpedance
    - TransformerCoreAdmittance
    - PhaseTapChanger
    - RatioTapChanger
    range: TransformerEnd
    required: true
  control_enabled:
    name: control_enabled
    description: Specifies the regulation status of the equipment.  True is regulating,
      false is not regulating.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TapChanger.controlEnabled
    multivalued: false
    alias: control_enabled
    owner: RatioTapChanger
    domain_of:
    - RegulatingCondEq
    - TapChanger
    range: boolean
    required: false
  high_step:
    name: high_step
    description: "Highest possible tap step position, advance from neutral.\r\nThe\
      \ attribute shall be greater than lowStep."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.highStep
    multivalued: false
    alias: high_step
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    - TapChangerInfo
    range: integer
    required: false
  initial_delay:
    name: initial_delay
    description: For an LTC, the delay for initial tap changer operation (first step
      change).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.initialDelay
    multivalued: false
    alias: initial_delay
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    range: Seconds
    required: false
  low_step:
    name: low_step
    description: Lowest possible tap step position, retard from neutral.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.lowStep
    multivalued: false
    alias: low_step
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    - TapChangerInfo
    range: integer
    required: false
  ltc_flag:
    name: ltc_flag
    description: Specifies whether or not a TapChanger has load tap changing capabilities.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.ltcFlag
    multivalued: false
    alias: ltc_flag
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    range: boolean
    required: false
  neutral_step:
    name: neutral_step
    description: "The neutral tap step position for this winding.\r\nThe attribute\
      \ shall be equal to or greater than lowStep and equal or less than highStep.\r\
      \nIt is the step position where the voltage is neutralU when the other terminals\
      \ of the transformer are at the ratedU.  If there are other tap changers on\
      \ the transformer those taps are kept constant at their neutralStep."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.neutralStep
    multivalued: false
    alias: neutral_step
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    - TapChangerInfo
    range: integer
    required: false
  neutral_u:
    name: neutral_u
    description: "Voltage at which the winding operates at the neutral tap setting.\
      \ It is the voltage at the terminal of the PowerTransformerEnd associated with\
      \ the tap changer when all tap changers on the transformer are at their neutralStep\
      \ position.  Normally neutralU of the tap changer is the same as ratedU of the\
      \ PowerTransformerEnd, but it can differ in special cases such as when the tapping\
      \ mechanism is separate from the winding more common on lower voltage transformers.\r\
      \nThis attribute is not relevant for PhaseTapChangerAsymmetrical, PhaseTapChangerSymmetrical\
      \ and PhaseTapChangerLinear. "
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.neutralU
    multivalued: false
    alias: neutral_u
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    - TapChangerInfo
    range: Voltage
    required: false
  normal_step:
    name: normal_step
    description: "The tap step position used in \"normal\" network operation for this\
      \ winding. For a \"Fixed\" tap changer indicates the current physical tap setting.\r\
      \nThe attribute shall be equal to or greater than lowStep and equal to or less\
      \ than highStep."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.normalStep
    multivalued: false
    alias: normal_step
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    range: integer
    required: false
  step:
    name: step
    description: "Tap changer position.\r\nStarting step for a steady state solution.\
      \ Non integer values are allowed to support continuous tap variables. The reasons\
      \ for continuous value are to support study cases where no discrete tap changer\
      \ has yet been designed, a solution where a narrow voltage band forces the tap\
      \ step to oscillate or to accommodate for a continuous solution as input.\r\n\
      The attribute shall be equal to or greater than lowStep and equal to or less\
      \ than highStep."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.step
    multivalued: false
    alias: step
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    - TapChangerTablePoint
    range: float
    required: false
  subsequent_delay:
    name: subsequent_delay
    description: For an LTC, the delay for subsequent tap changer operation (second
      and later step changes).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.subsequentDelay
    multivalued: false
    alias: subsequent_delay
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    range: Seconds
    required: false
  tap_changer_control:
    name: tap_changer_control
    description: The regulating control scheme in which this tap changer participates.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.TapChangerControl
    multivalued: false
    alias: tap_changer_control
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    range: TapChangerControl
    required: false
  sv_tap_step:
    name: sv_tap_step
    description: The tap step state associated with the tap changer.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.SvTapStep
    multivalued: false
    alias: sv_tap_step
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    range: SvTapStep
    required: false
  tap_schedules:
    name: tap_schedules
    description: A TapChanger can have TapSchedules.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TapChanger.TapSchedules
    multivalued: true
    alias: tap_schedules
    owner: RatioTapChanger
    domain_of:
    - TapChanger
    range: TapSchedule
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    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: RatioTapChanger
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:RatioTapChanger