Class: Bay

name: Bay
description: "A collection of power system resources (within a given substation) including\
  \ conducting equipment, protection relays, measurements, and telemetry.  A bay typically\
  \ represents a physical grouping related to modularization of equipment.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: EquipmentContainer
attributes:
  bay_energy_meas_flag:
    name: bay_energy_meas_flag
    description: Indicates the presence/absence of energy measurements.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Bay.bayEnergyMeasFlag
    multivalued: false
    domain_of:
    - Bay
    range: boolean
    required: false
  bay_power_meas_flag:
    name: bay_power_meas_flag
    description: Indicates the presence/absence of active/reactive power measurements.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Bay.bayPowerMeasFlag
    multivalued: false
    domain_of:
    - Bay
    range: boolean
    required: false
  breaker_configuration:
    name: breaker_configuration
    description: 'Breaker configuration. '
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Bay.breakerConfiguration
    multivalued: false
    domain_of:
    - Bay
    range: BreakerConfiguration
    required: false
  bus_bar_configuration:
    name: bus_bar_configuration
    description: Busbar configuration.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Bay.busBarConfiguration
    multivalued: false
    domain_of:
    - Bay
    range: BusbarConfiguration
    required: false
  substation:
    name: substation
    description: Substation containing the bay.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Bay.Substation
    multivalued: false
    domain_of:
    - VoltageLevel
    - Bay
    - DCConverterUnit
    range: Substation
    required: false
  voltage_level:
    name: voltage_level
    description: The voltage level containing this bay.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Bay.VoltageLevel
    multivalued: false
    domain_of:
    - BaseVoltage
    - Bay
    range: VoltageLevel
    required: false
  circuit:
    name: circuit
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Bay.Circuit
    multivalued: false
    domain_of:
    - Terminal
    - Bay
    range: Circuit
    required: false
class_uri: cim:Bay

name: Bay
description: "A collection of power system resources (within a given substation) including\
  \ conducting equipment, protection relays, measurements, and telemetry.  A bay typically\
  \ represents a physical grouping related to modularization of equipment.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: EquipmentContainer
attributes:
  bay_energy_meas_flag:
    name: bay_energy_meas_flag
    description: Indicates the presence/absence of energy measurements.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Bay.bayEnergyMeasFlag
    multivalued: false
    alias: bay_energy_meas_flag
    owner: Bay
    domain_of:
    - Bay
    range: boolean
    required: false
  bay_power_meas_flag:
    name: bay_power_meas_flag
    description: Indicates the presence/absence of active/reactive power measurements.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Bay.bayPowerMeasFlag
    multivalued: false
    alias: bay_power_meas_flag
    owner: Bay
    domain_of:
    - Bay
    range: boolean
    required: false
  breaker_configuration:
    name: breaker_configuration
    description: 'Breaker configuration. '
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Bay.breakerConfiguration
    multivalued: false
    alias: breaker_configuration
    owner: Bay
    domain_of:
    - Bay
    range: BreakerConfiguration
    required: false
  bus_bar_configuration:
    name: bus_bar_configuration
    description: Busbar configuration.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Bay.busBarConfiguration
    multivalued: false
    alias: bus_bar_configuration
    owner: Bay
    domain_of:
    - Bay
    range: BusbarConfiguration
    required: false
  substation:
    name: substation
    description: Substation containing the bay.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Bay.Substation
    multivalued: false
    alias: substation
    owner: Bay
    domain_of:
    - VoltageLevel
    - Bay
    - DCConverterUnit
    range: Substation
    required: false
  voltage_level:
    name: voltage_level
    description: The voltage level containing this bay.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Bay.VoltageLevel
    multivalued: false
    alias: voltage_level
    owner: Bay
    domain_of:
    - BaseVoltage
    - Bay
    range: VoltageLevel
    required: false
  circuit:
    name: circuit
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Bay.Circuit
    multivalued: false
    alias: circuit
    owner: Bay
    domain_of:
    - Terminal
    - Bay
    range: Circuit
    required: false
  equipments:
    name: equipments
    description: Contained equipment.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EquipmentContainer.Equipments
    multivalued: true
    alias: equipments
    owner: Bay
    domain_of:
    - EquipmentContainer
    - UsagePoint
    - OperationalRestriction
    - Outage
    range: Equipment
    required: false
  additional_grouped_equipment:
    name: additional_grouped_equipment
    description: The additonal contained equipment.  The equipment belong to the equipment
      container. The equipment is contained in another equipment container, but also
      grouped with this equipment container.  Examples include when a switch contained
      in a substation is also desired to be grouped with a line contianer or when
      a switch is included in a secondary substation and also grouped in a feeder.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EquipmentContainer.AdditionalGroupedEquipment
    multivalued: true
    alias: additional_grouped_equipment
    owner: Bay
    domain_of:
    - EquipmentContainer
    range: Equipment
    required: false
  topological_node:
    name: topological_node
    description: The topological nodes which belong to this connectivity node container.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ConnectivityNodeContainer.TopologicalNode
    multivalued: true
    alias: topological_node
    owner: Bay
    domain_of:
    - ReportingGroup
    - BusNameMarker
    - ConnectivityNodeContainer
    - SvInjection
    - SvVoltage
    - ConnectivityNode
    - Terminal
    - BaseVoltage
    range: TopologicalNode
    required: false
  connectivity_nodes:
    name: connectivity_nodes
    description: Connectivity nodes which belong to this connectivity node container.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ConnectivityNodeContainer.ConnectivityNodes
    multivalued: true
    alias: connectivity_nodes
    owner: Bay
    domain_of:
    - ConnectivityNodeContainer
    - TopologicalNode
    range: ConnectivityNode
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    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: Bay
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:Bay