Class: ShuntCompensatorPhase

name: ShuntCompensatorPhase
description: Single phase of a multi-phase shunt compensator when its attributes might
  be different per phase.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: PowerSystemResource
attributes:
  maximum_sections:
    name: maximum_sections
    description: "The maximum number of sections that may be switched in for this\
      \ phase. \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.maximumSections
    multivalued: false
    domain_of:
    - ShuntCompensatorPhase
    - ShuntCompensator
    range: integer
    required: false
  normal_sections:
    name: normal_sections
    description: "For the capacitor phase, the normal number of sections switched\
      \ in. The value shall be between zero and ShuntCompensatorPhase.maximumSections.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.normalSections
    multivalued: false
    domain_of:
    - ShuntCompensatorPhase
    - ShuntCompensator
    range: integer
    required: false
  phase:
    name: phase
    description: "Phase of this shunt compensator component.   If the shunt compensator\
      \ is wye connected, the connection is from the indicated phase to the central\
      \ ground or neutral point.  If the shunt compensator is delta connected, the\
      \ phase indicates a shunt compensator connected from the indicated phase to\
      \ the next logical non-neutral phase.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ShuntCompensatorPhase.phase
    multivalued: false
    domain_of:
    - SvInjection
    - SvVoltage
    - SvStatus
    - ACLineSegmentPhase
    - SvSwitch
    - SvPowerFlow
    - PowerElectronicsConnectionPhase
    - ShuntCompensatorPhase
    - SvShuntCompensatorSections
    - EnergyConsumerPhase
    - EnergySourcePhase
    - WireSegmentPhase
    range: SinglePhaseKind
    required: false
  sections:
    name: sections
    description: "Shunt compensator sections in use. Starting value for steady state\
      \ solution. The attribute shall be a positive value or zero. Non integer values\
      \ are allowed to support continuous variables. The reasons for continuous value\
      \ are to support study cases where no discrete shunt compensators has yet been\
      \ designed, a solutions where a narrow voltage band force the sections to oscillate\
      \ or accommodate for a continuous solution as input.\r\nFor LinearShuntConpensator\
      \ the value shall be between zero and ShuntCompensatorPhase.maximumSections.\
      \ At value zero the shunt compensator conductance and admittance is zero. Linear\
      \ interpolation of conductance and admittance between the previous and next\
      \ integer section is applied in case of non-integer values.\r\nFor NonlinearShuntCompensator-s\
      \ shall only be set to one of the NonlinearShuntCompenstorPhasePoint.sectionNumber.\
      \ There is no interpolation between NonlinearShuntCompenstorPhasePoint-s."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.sections
    multivalued: false
    domain_of:
    - ShuntCompensatorPhase
    - ShuntCompensator
    - SvShuntCompensatorSections
    range: float
    required: false
  shunt_compensator:
    name: shunt_compensator
    description: Shunt compensator of this shunt compensator phase.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.ShuntCompensator
    multivalued: false
    domain_of:
    - ShuntCompensatorPhase
    - SvShuntCompensatorSections
    - ShuntCompensatorAction
    range: ShuntCompensator
    required: true
class_uri: cim:ShuntCompensatorPhase

name: ShuntCompensatorPhase
description: Single phase of a multi-phase shunt compensator when its attributes might
  be different per phase.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: PowerSystemResource
attributes:
  maximum_sections:
    name: maximum_sections
    description: "The maximum number of sections that may be switched in for this\
      \ phase. \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.maximumSections
    multivalued: false
    alias: maximum_sections
    owner: ShuntCompensatorPhase
    domain_of:
    - ShuntCompensatorPhase
    - ShuntCompensator
    range: integer
    required: false
  normal_sections:
    name: normal_sections
    description: "For the capacitor phase, the normal number of sections switched\
      \ in. The value shall be between zero and ShuntCompensatorPhase.maximumSections.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.normalSections
    multivalued: false
    alias: normal_sections
    owner: ShuntCompensatorPhase
    domain_of:
    - ShuntCompensatorPhase
    - ShuntCompensator
    range: integer
    required: false
  phase:
    name: phase
    description: "Phase of this shunt compensator component.   If the shunt compensator\
      \ is wye connected, the connection is from the indicated phase to the central\
      \ ground or neutral point.  If the shunt compensator is delta connected, the\
      \ phase indicates a shunt compensator connected from the indicated phase to\
      \ the next logical non-neutral phase.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ShuntCompensatorPhase.phase
    multivalued: false
    alias: phase
    owner: ShuntCompensatorPhase
    domain_of:
    - SvInjection
    - SvVoltage
    - SvStatus
    - ACLineSegmentPhase
    - SvSwitch
    - SvPowerFlow
    - PowerElectronicsConnectionPhase
    - ShuntCompensatorPhase
    - SvShuntCompensatorSections
    - EnergyConsumerPhase
    - EnergySourcePhase
    - WireSegmentPhase
    range: SinglePhaseKind
    required: false
  sections:
    name: sections
    description: "Shunt compensator sections in use. Starting value for steady state\
      \ solution. The attribute shall be a positive value or zero. Non integer values\
      \ are allowed to support continuous variables. The reasons for continuous value\
      \ are to support study cases where no discrete shunt compensators has yet been\
      \ designed, a solutions where a narrow voltage band force the sections to oscillate\
      \ or accommodate for a continuous solution as input.\r\nFor LinearShuntConpensator\
      \ the value shall be between zero and ShuntCompensatorPhase.maximumSections.\
      \ At value zero the shunt compensator conductance and admittance is zero. Linear\
      \ interpolation of conductance and admittance between the previous and next\
      \ integer section is applied in case of non-integer values.\r\nFor NonlinearShuntCompensator-s\
      \ shall only be set to one of the NonlinearShuntCompenstorPhasePoint.sectionNumber.\
      \ There is no interpolation between NonlinearShuntCompenstorPhasePoint-s."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.sections
    multivalued: false
    alias: sections
    owner: ShuntCompensatorPhase
    domain_of:
    - ShuntCompensatorPhase
    - ShuntCompensator
    - SvShuntCompensatorSections
    range: float
    required: false
  shunt_compensator:
    name: shunt_compensator
    description: Shunt compensator of this shunt compensator phase.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ShuntCompensatorPhase.ShuntCompensator
    multivalued: false
    alias: shunt_compensator
    owner: ShuntCompensatorPhase
    domain_of:
    - ShuntCompensatorPhase
    - SvShuntCompensatorSections
    - ShuntCompensatorAction
    range: ShuntCompensator
    required: true
  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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    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: ShuntCompensatorPhase
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:ShuntCompensatorPhase