Skip to content

Class: EnergyConsumer

Generic user of energy - a point of consumption on the power system model.

EnergyConsumer.pfixed, .qfixed, .pfixedPct and .qfixedPct have meaning only if there is no LoadResponseCharacteristic associated with EnergyConsumer or if LoadResponseCharacteristic.exponentModel is set to False.

URI: cim:EnergyConsumer

 classDiagram
    class EnergyConsumer
      EnergyConnection <|-- EnergyConsumer

      EnergyConsumer : Equipment.aggregate

      EnergyConsumer : ConductingEquipment.BaseVoltage

          EnergyConsumer --> BaseVoltage : ConductingEquipment.BaseVoltage

      EnergyConsumer : IdentifiedObject.description

      EnergyConsumer : IdentifiedObject.energyIdentCodeEic

      EnergyConsumer : Equipment.EquipmentContainer

          EnergyConsumer --> EquipmentContainer : Equipment.EquipmentContainer

      EnergyConsumer : IdentifiedObject.mRID

      EnergyConsumer : IdentifiedObject.Names

          EnergyConsumer --> Name : IdentifiedObject.Names

      EnergyConsumer : Equipment.normallyInService

      EnergyConsumer : EnergyConsumer.pfixed

          EnergyConsumer --> ActivePower : EnergyConsumer.pfixed

      EnergyConsumer : EnergyConsumer.pfixedPct

          EnergyConsumer --> PerCent : EnergyConsumer.pfixedPct

      EnergyConsumer : EnergyConsumer.qfixed

          EnergyConsumer --> ReactivePower : EnergyConsumer.qfixed

      EnergyConsumer : EnergyConsumer.qfixedPct

          EnergyConsumer --> PerCent : EnergyConsumer.qfixedPct

      EnergyConsumer : IdentifiedObject.shortName

      EnergyConsumer : ConductingEquipment.Terminals

          EnergyConsumer --> Terminal : ConductingEquipment.Terminals

Inheritance

Slots

Name Cardinality and Range Description Inheritance
pfixed 0..1
ActivePower		 Active power of the load that is a fixed quantity and does not vary as load g... direct
pfixed_pct 0..1
PerCent		 Fixed active power as a percentage of load group fixed active power direct
qfixed 0..1
ReactivePower		 Reactive power of the load that is a fixed quantity and does not vary as load... direct
qfixed_pct 0..1
PerCent		 Fixed reactive power as a percentage of load group fixed reactive power direct
base_voltage 0..1
BaseVoltage		 Base voltage of this conducting equipment ConductingEquipment
terminals 0..*
Terminal		 Conducting equipment have terminals that may be connected to other conducting... ConductingEquipment
aggregate 0..1
Boolean		 The aggregate flag provides an alternative way of representing an aggregated ... 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
description 0..1
String		 The description is a free human readable text describing or naming the object IdentifiedObject
energy_ident_code_eic 0..1
String		 The attribute is used for an exchange of the EIC code (Energy identification ... IdentifiedObject
m_rid 1..1
String		 Master resource identifier issued by a model authority IdentifiedObject
short_name 0..1
String		 The attribute is used for an exchange of a human readable short name with len... IdentifiedObject
names 0..*
Name		 All names of this identified object IdentifiedObject

Identifier and Mapping Information

Schema Source

  • from schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile

Mappings

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

LinkML Source

Direct

name: EnergyConsumer
description: 'Generic user of energy - a  point of consumption on the power system
  model.

  EnergyConsumer.pfixed, .qfixed, .pfixedPct and .qfixedPct have meaning only if there
  is no LoadResponseCharacteristic associated with EnergyConsumer or if LoadResponseCharacteristic.exponentModel
  is set to False.'
from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
rank: 1000
is_a: EnergyConnection
attributes:
  pfixed:
    name: pfixed
    description: Active power of the load that is a fixed quantity and does not vary
      as load group value varies. Load sign convention is used, i.e. positive sign
      means flow out from a node.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:EnergyConsumer.pfixed
    multivalued: false
    domain_of:
    - EnergyConsumer
    range: ActivePower
    required: false
  pfixed_pct:
    name: pfixed_pct
    description: Fixed active power as a percentage of load group fixed active power.
      Used to represent the time-varying components.  Load sign convention is used,
      i.e. positive sign means flow out from a node.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:EnergyConsumer.pfixedPct
    multivalued: false
    domain_of:
    - EnergyConsumer
    range: PerCent
    required: false
  qfixed:
    name: qfixed
    description: Reactive power of the load that is a fixed quantity and does not
      vary as load group value varies. Load sign convention is used, i.e. positive
      sign means flow out from a node.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:EnergyConsumer.qfixed
    multivalued: false
    domain_of:
    - EnergyConsumer
    range: ReactivePower
    required: false
  qfixed_pct:
    name: qfixed_pct
    description: Fixed reactive power as a percentage of load group fixed reactive
      power. Used to represent the time-varying components.  Load sign convention
      is used, i.e. positive sign means flow out from a node.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:EnergyConsumer.qfixedPct
    multivalued: false
    domain_of:
    - EnergyConsumer
    range: PerCent
    required: false
class_uri: cim:EnergyConsumer

Induced

name: EnergyConsumer
description: 'Generic user of energy - a  point of consumption on the power system
  model.

  EnergyConsumer.pfixed, .qfixed, .pfixedPct and .qfixedPct have meaning only if there
  is no LoadResponseCharacteristic associated with EnergyConsumer or if LoadResponseCharacteristic.exponentModel
  is set to False.'
from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
rank: 1000
is_a: EnergyConnection
attributes:
  pfixed:
    name: pfixed
    description: Active power of the load that is a fixed quantity and does not vary
      as load group value varies. Load sign convention is used, i.e. positive sign
      means flow out from a node.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:EnergyConsumer.pfixed
    multivalued: false
    alias: pfixed
    owner: EnergyConsumer
    domain_of:
    - EnergyConsumer
    range: ActivePower
    required: false
  pfixed_pct:
    name: pfixed_pct
    description: Fixed active power as a percentage of load group fixed active power.
      Used to represent the time-varying components.  Load sign convention is used,
      i.e. positive sign means flow out from a node.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:EnergyConsumer.pfixedPct
    multivalued: false
    alias: pfixed_pct
    owner: EnergyConsumer
    domain_of:
    - EnergyConsumer
    range: PerCent
    required: false
  qfixed:
    name: qfixed
    description: Reactive power of the load that is a fixed quantity and does not
      vary as load group value varies. Load sign convention is used, i.e. positive
      sign means flow out from a node.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:EnergyConsumer.qfixed
    multivalued: false
    alias: qfixed
    owner: EnergyConsumer
    domain_of:
    - EnergyConsumer
    range: ReactivePower
    required: false
  qfixed_pct:
    name: qfixed_pct
    description: Fixed reactive power as a percentage of load group fixed reactive
      power. Used to represent the time-varying components.  Load sign convention
      is used, i.e. positive sign means flow out from a node.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:EnergyConsumer.qfixedPct
    multivalued: false
    alias: qfixed_pct
    owner: EnergyConsumer
    domain_of:
    - EnergyConsumer
    range: PerCent
    required: false
  base_voltage:
    name: base_voltage
    description: Base voltage of this conducting equipment.  Use only when there is
      no voltage level container used and only one base voltage applies.  For example,
      not used for transformers.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:ConductingEquipment.BaseVoltage
    multivalued: false
    alias: base_voltage
    owner: EnergyConsumer
    domain_of:
    - ConductingEquipment
    - VoltageLevel
    - TransformerEnd
    range: BaseVoltage
    required: false
  terminals:
    name: terminals
    description: Conducting equipment have terminals that may be connected to other
      conducting equipment terminals via connectivity nodes or topological nodes.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:ConductingEquipment.Terminals
    multivalued: true
    alias: terminals
    owner: EnergyConsumer
    domain_of:
    - ConductingEquipment
    - ConnectivityNode
    range: Terminal
    required: false
  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.  \nThe attribute is not used for EquivalentBranch,\
      \ EquivalentShunt and EquivalentInjection."
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:Equipment.aggregate
    multivalued: false
    alias: aggregate
    owner: EnergyConsumer
    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: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:Equipment.normallyInService
    multivalued: false
    alias: normally_in_service
    owner: EnergyConsumer
    domain_of:
    - Equipment
    range: boolean
    required: false
  equipment_container:
    name: equipment_container
    description: Container of this equipment.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:Equipment.EquipmentContainer
    multivalued: false
    alias: equipment_container
    owner: EnergyConsumer
    domain_of:
    - Equipment
    range: EquipmentContainer
    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: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:IdentifiedObject.description
    multivalued: false
    alias: description
    owner: EnergyConsumer
    domain_of:
    - IdentifiedObject
    - NameType
    - NameTypeAuthority
    range: string
    required: false
  energy_ident_code_eic:
    name: energy_ident_code_eic
    description: The attribute is used for an exchange of the EIC code (Energy identification
      Code). The length of the string is 16 characters as defined by the EIC code.
      For details on EIC scheme please refer to ENTSO-E web site.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: eu:IdentifiedObject.energyIdentCodeEic
    multivalued: false
    alias: energy_ident_code_eic
    owner: EnergyConsumer
    domain_of:
    - IdentifiedObject
    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.

      For 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: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:IdentifiedObject.mRID
    multivalued: false
    alias: m_rid
    owner: EnergyConsumer
    domain_of:
    - IdentifiedObject
    range: string
    required: true
  short_name:
    name: short_name
    description: The attribute is used for an exchange of a human readable short name
      with length of the string 12 characters maximum.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: eu:IdentifiedObject.shortName
    multivalued: false
    alias: short_name
    owner: EnergyConsumer
    domain_of:
    - IdentifiedObject
    range: string
    required: false
  names:
    name: names
    description: All names of this identified object.
    from_schema: http://iec.ch/TC57/ns/CIM/CoreEquipment-EU#Package_CoreEquipmentProfile
    rank: 1000
    slot_uri: cim:IdentifiedObject.Names
    multivalued: true
    alias: names
    owner: EnergyConsumer
    domain_of:
    - IdentifiedObject
    - NameType
    range: Name
    required: false
class_uri: cim:EnergyConsumer