Skip to content

Class: AuxiliaryEquipment

_AuxiliaryEquipment describe equipment that is not performing any primary functions but support for the equipment performing the primary function. _

AuxiliaryEquipment is attached to primary equipment via an association with Terminal.

URI: cim:AuxiliaryEquipment

 classDiagram
    class AuxiliaryEquipment
      Equipment <|-- AuxiliaryEquipment


      AuxiliaryEquipment <|-- Sensor


      AuxiliaryEquipment : additional_equipment_container

          AuxiliaryEquipment --> EquipmentContainer : additional_equipment_container

      AuxiliaryEquipment : aggregate

      AuxiliaryEquipment : alias_name

      AuxiliaryEquipment : description

      AuxiliaryEquipment : equipment_container

          AuxiliaryEquipment --> EquipmentContainer : equipment_container

      AuxiliaryEquipment : in_service

      AuxiliaryEquipment : m_rid

      AuxiliaryEquipment : measurements

          AuxiliaryEquipment --> Measurement : measurements

      AuxiliaryEquipment : names

          AuxiliaryEquipment --> Name : names

      AuxiliaryEquipment : network_analysis_enabled

      AuxiliaryEquipment : normally_in_service

      AuxiliaryEquipment : psrevents

          AuxiliaryEquipment --> PSREvent : psrevents

      AuxiliaryEquipment : terminal

          AuxiliaryEquipment --> Terminal : terminal

Inheritance

Slots

Name Cardinality and Range Description Inheritance
terminal 1..1
Terminal
The Terminal at the equipment where the AuxiliaryEquipment is attached direct
aggregate 0..1
Boolean
The aggregate flag provides an alternative way of representing an aggregated ... Equipment
in_service 0..1
Boolean
Specifies the availability of the equipment Equipment
network_analysis_enabled 0..1
Boolean
The equipment is enabled to participate in network analysis Equipment
normally_in_service 0..1
Boolean
Specifies the availability of the equipment under normal operating conditions Equipment
equipment_container 0..1
EquipmentContainer
Container of this equipment Equipment
additional_equipment_container 0..*
EquipmentContainer
Additional equipment container beyond the primary equipment container Equipment
measurements 0..*
Measurement
The measurements associated with this power system resource PowerSystemResource
psrevents 0..*
PSREvent
All events associated with this power system resource PowerSystemResource
alias_name 0..1
String
The aliasName is free text human readable name of the object alternative to I... IdentifiedObject
description 0..1
String
The description is a free human readable text describing or naming the object IdentifiedObject
m_rid 0..1
String
Master resource identifier issued by a model authority IdentifiedObject
names 0..*
Name
All names of this identified object IdentifiedObject

Usages

used by used in type used
Terminal auxiliary_equipment range AuxiliaryEquipment

Identifier and Mapping Information

Schema Source

  • from schema: https://cim.ucaiug.io/ns#TC57CIM

Mappings

Mapping Type Mapped Value
self cim:AuxiliaryEquipment
native this:AuxiliaryEquipment

LinkML Source

Direct

name: AuxiliaryEquipment
description: "AuxiliaryEquipment describe equipment that is not performing any primary\
  \ functions but support for the equipment performing the primary function.\r\nAuxiliaryEquipment\
  \ is attached to primary equipment via an association with Terminal."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Equipment
attributes:
  terminal:
    name: terminal
    description: The Terminal at the equipment where the AuxiliaryEquipment is attached.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AuxiliaryEquipment.Terminal
    multivalued: false
    domain_of:
    - Measurement
    - AuxiliaryEquipment
    range: Terminal
    required: true
class_uri: cim:AuxiliaryEquipment

Induced

name: AuxiliaryEquipment
description: "AuxiliaryEquipment describe equipment that is not performing any primary\
  \ functions but support for the equipment performing the primary function.\r\nAuxiliaryEquipment\
  \ is attached to primary equipment via an association with Terminal."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Equipment
attributes:
  terminal:
    name: terminal
    description: The Terminal at the equipment where the AuxiliaryEquipment is attached.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AuxiliaryEquipment.Terminal
    multivalued: false
    alias: terminal
    owner: AuxiliaryEquipment
    domain_of:
    - Measurement
    - AuxiliaryEquipment
    range: Terminal
    required: true
  aggregate:
    name: aggregate
    description: "The aggregate flag provides an alternative way of representing an\
      \ aggregated (equivalent) element. It is applicable in cases when the dedicated\
      \ classes for equivalent equipment do not have all of the attributes necessary\
      \ to represent the required level of detail.  In case the flag is set to “true”\
      \ the single instance of equipment represents multiple pieces of equipment that\
      \ have been modelled together as an aggregate equivalent obtained by a network\
      \ reduction procedure. Examples would be power transformers or synchronous machines\
      \ operating in parallel modelled as a single aggregate power transformer or\
      \ aggregate synchronous machine.  \r\nThe attribute is not used for EquivalentBranch,\
      \ EquivalentShunt and EquivalentInjection."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Equipment.aggregate
    multivalued: false
    alias: aggregate
    owner: AuxiliaryEquipment
    domain_of:
    - Equipment
    range: boolean
    required: false
  in_service:
    name: in_service
    description: Specifies the availability of the equipment. True means the equipment
      is available for topology processing, which determines if the equipment is energized
      or not. False means that the equipment is treated by network applications as
      if it is not in the model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Equipment.inService
    multivalued: false
    alias: in_service
    owner: AuxiliaryEquipment
    domain_of:
    - Equipment
    range: boolean
    required: false
  network_analysis_enabled:
    name: network_analysis_enabled
    description: The equipment is enabled to participate in network analysis.  If
      unspecified, the value is assumed to be true.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Equipment.networkAnalysisEnabled
    multivalued: false
    alias: network_analysis_enabled
    owner: AuxiliaryEquipment
    domain_of:
    - Equipment
    range: boolean
    required: false
  normally_in_service:
    name: normally_in_service
    description: Specifies the availability of the equipment under normal operating
      conditions. True means the equipment is available for topology processing, which
      determines if the equipment is energized or not. False means that the equipment
      is treated by network applications as if it is not in the model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Equipment.normallyInService
    multivalued: false
    alias: normally_in_service
    owner: AuxiliaryEquipment
    domain_of:
    - Equipment
    range: boolean
    required: false
  equipment_container:
    name: equipment_container
    description: Container of this equipment.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Equipment.EquipmentContainer
    multivalued: false
    alias: equipment_container
    owner: AuxiliaryEquipment
    domain_of:
    - Equipment
    range: EquipmentContainer
    required: false
  additional_equipment_container:
    name: additional_equipment_container
    description: Additional equipment container beyond the primary equipment container.  The
      equipment is contained in another equipment container, but also grouped with
      this equipment container.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Equipment.AdditionalEquipmentContainer
    multivalued: true
    alias: additional_equipment_container
    owner: AuxiliaryEquipment
    domain_of:
    - Equipment
    range: EquipmentContainer
    required: false
  measurements:
    name: measurements
    description: The measurements associated with this power system resource.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PowerSystemResource.Measurements
    multivalued: true
    alias: measurements
    owner: AuxiliaryEquipment
    domain_of:
    - ACDCTerminal
    - PowerSystemResource
    range: Measurement
    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: AuxiliaryEquipment
    domain_of:
    - PowerSystemResource
    range: PSREvent
    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: AuxiliaryEquipment
    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: AuxiliaryEquipment
    domain_of:
    - IdentifiedObject
    - NameType
    - NameTypeAuthority
    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: AuxiliaryEquipment
    domain_of:
    - IdentifiedObject
    range: string
    required: false
  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: AuxiliaryEquipment
    domain_of:
    - IdentifiedObject
    - NameType
    range: Name
    required: false
class_uri: cim:AuxiliaryEquipment