Skip to content

Class: EnergyConsumerAction

Action to connect or disconnect the Energy Consumer from its Terminal

URI: cim:EnergyConsumerAction

 classDiagram
    class EnergyConsumerAction
      SwitchingAction <|-- EnergyConsumerAction

      EnergyConsumerAction : alias_name

      EnergyConsumerAction : crew

          EnergyConsumerAction --> Crew : crew

      EnergyConsumerAction : description

      EnergyConsumerAction : diagram_objects

          EnergyConsumerAction --> DiagramObject : diagram_objects

      EnergyConsumerAction : energy_consumer

          EnergyConsumerAction --> EnergyConsumer : energy_consumer

      EnergyConsumerAction : executed_date_time

      EnergyConsumerAction : instance_set

          EnergyConsumerAction --> InstanceSet : instance_set

      EnergyConsumerAction : issued_date_time

      EnergyConsumerAction : kind

          EnergyConsumerAction --> TempEquipActionKind : kind

      EnergyConsumerAction : m_rid

      EnergyConsumerAction : names

          EnergyConsumerAction --> Name : names

      EnergyConsumerAction : operator

          EnergyConsumerAction --> Operator : operator

      EnergyConsumerAction : phases

          EnergyConsumerAction --> PhaseCode : phases

      EnergyConsumerAction : planned_date_time

      EnergyConsumerAction : properties_cimdata_object

          EnergyConsumerAction --> ChangeSetMember : properties_cimdata_object

      EnergyConsumerAction : switching_event

          EnergyConsumerAction --> SwitchingEvent : switching_event

      EnergyConsumerAction : switching_plan

          EnergyConsumerAction --> SwitchingPlan : switching_plan

      EnergyConsumerAction : switching_step

          EnergyConsumerAction --> SwitchingStep : switching_step

      EnergyConsumerAction : targeting_cimdata_object

          EnergyConsumerAction --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
kind 0..1
TempEquipActionKind		 Switching action to perform direct
energy_consumer 0..1
EnergyConsumer		 The energy consumer that the energy consumer action is performed on direct
executed_date_time 0..1
date		 Actual date and time of this switching step SwitchingAction
issued_date_time 0..1
date		 Date and time when the crew was given the instruction to execute the action; ... SwitchingAction
phases 0..1
PhaseCode		 Phases of the Switching Action SwitchingAction
planned_date_time 0..1
date		 Planned date and time of this switching step SwitchingAction
switching_plan 0..1
SwitchingPlan		 The switching plan that is associated with the switching actions SwitchingAction
operator 0..1
Operator		 Operator responsible for this switching step SwitchingAction
crew 0..*
Crew		 The crew that is assigned to the switching action SwitchingAction
switching_event 0..1
SwitchingEvent		 The switching event that the switching action is performed on SwitchingAction
switching_step 0..1
SwitchingStep		 The switching step that is associated to the switching action SwitchingAction
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
diagram_objects 0..*
DiagramObject		 The diagram objects that are associated with the domain object IdentifiedObject
instance_set 1..1
InstanceSet		 Dataset containing the data objects IdentifiedObject
names 0..*
Name		 All names of this identified object IdentifiedObject
properties_cimdata_object 0..1
ChangeSetMember		 The single CIM data object in the appropriate dataset context IdentifiedObject
targeting_cimdata_object 0..*
ChangeSetMember		 Data objects registered IdentifiedObject

Usages

used by used in type used
EnergyConsumer energy_consumer_action range EnergyConsumerAction
ConformLoad energy_consumer_action range EnergyConsumerAction
NonConformLoad energy_consumer_action range EnergyConsumerAction
StationSupply energy_consumer_action range EnergyConsumerAction

Identifier and Mapping Information

Schema Source

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

Mappings

Mapping Type Mapped Value
self cim:EnergyConsumerAction
native cim:EnergyConsumerAction

LinkML Source

Direct

name: EnergyConsumerAction
description: Action to connect or disconnect the Energy Consumer from its Terminal
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: SwitchingAction
attributes:
  kind:
    name: kind
    description: Switching action to perform
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyConsumerAction.kind
    multivalued: false
    domain_of:
    - Asset
    - Customer
    - BaseWork
    - WorkTimeSchedule
    - CustomerBillingInfo
    - ErpInvoiceLineItem
    - CatalogAssetType
    - Design
    - ConditionFactor
    - LandProperty
    - Seal
    - Gate
    - JumperAction
    - RevisionHistory
    - SwitchAction
    - Fault
    - ServiceCategory
    - Transaction
    - Procedure
    - Medium
    - Tender
    - Cheque
    - Charge
    - ServiceRequest
    - MeterMultiplier
    - StructureSupport
    - CutAction
    - GroundAction
    - ClampAction
    - ProtectiveActionAdjustment
    - RemedialActionScheme
    - MeasurementCalculator
    - ErpInvoice
    - ServiceSupplier
    - EnergyTypeReference
    - CRROrgRole
    - MarketInvoice
    - MarketInvoiceLineItem
    - EnvironmentalLocationType
    - EnvironmentalDiscrete
    - ServiceMultiplier
    - AssetLocationHazard
    - Analytic
    - AssetGroup
    - TagAction
    - PinBranchGroup
    - PinTerminal
    - PinEquipment
    - ClearanceAction
    - PSREvent
    - ShuntCompensatorAction
    - EnergyConsumerAction
    - EnergySourceAction
    - Zone
    - OilAnalysisMoistureAnalog
    - AssetStringMeasurement
    - InspectionAnalog
    - AssetTemperaturePressureAnalog
    - OilAnalysisFluidDiscrete
    - InspectionDiscrete
    - OilAnalysisPCBDiscrete
    - OilAnalysisFluidAnalog
    - OilAnalysisGasAnalog
    - OilAnalysisPCBAnalog
    - OilAnalysisParticleDiscrete
    - OilAnalysisMetalsAnalog
    - OilAnalysisParticleAnalog
    - OilAnalysisPaperAnalog
    - CompositeSwitchInfo
    - Facility
    - RiskScore
    - FACTSDevice
    - SimpleEndDeviceFunction
    - UndergroundStructure
    - RelativeDisplacement
    - CloudCondition
    - GeosphericAnalog
    - HydrosphericAnalog
    - AtmosphericAnalog
    - SpaceAnalog
    range: TempEquipActionKind
    required: false
  energy_consumer:
    name: energy_consumer
    description: The energy consumer that the energy consumer action is performed
      on
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyConsumerAction.EnergyConsumer
    multivalued: false
    domain_of:
    - EnergyConsumerPhase
    - LoadDynamics
    - LoadResponseCharacteristic
    - EnergyConsumerAction
    range: EnergyConsumer
    required: false
class_uri: cim:EnergyConsumerAction

Induced

name: EnergyConsumerAction
description: Action to connect or disconnect the Energy Consumer from its Terminal
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: SwitchingAction
attributes:
  kind:
    name: kind
    description: Switching action to perform
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyConsumerAction.kind
    multivalued: false
    alias: kind
    owner: EnergyConsumerAction
    domain_of:
    - Asset
    - Customer
    - BaseWork
    - WorkTimeSchedule
    - CustomerBillingInfo
    - ErpInvoiceLineItem
    - CatalogAssetType
    - Design
    - ConditionFactor
    - LandProperty
    - Seal
    - Gate
    - JumperAction
    - RevisionHistory
    - SwitchAction
    - Fault
    - ServiceCategory
    - Transaction
    - Procedure
    - Medium
    - Tender
    - Cheque
    - Charge
    - ServiceRequest
    - MeterMultiplier
    - StructureSupport
    - CutAction
    - GroundAction
    - ClampAction
    - ProtectiveActionAdjustment
    - RemedialActionScheme
    - MeasurementCalculator
    - ErpInvoice
    - ServiceSupplier
    - EnergyTypeReference
    - CRROrgRole
    - MarketInvoice
    - MarketInvoiceLineItem
    - EnvironmentalLocationType
    - EnvironmentalDiscrete
    - ServiceMultiplier
    - AssetLocationHazard
    - Analytic
    - AssetGroup
    - TagAction
    - PinBranchGroup
    - PinTerminal
    - PinEquipment
    - ClearanceAction
    - PSREvent
    - ShuntCompensatorAction
    - EnergyConsumerAction
    - EnergySourceAction
    - Zone
    - OilAnalysisMoistureAnalog
    - AssetStringMeasurement
    - InspectionAnalog
    - AssetTemperaturePressureAnalog
    - OilAnalysisFluidDiscrete
    - InspectionDiscrete
    - OilAnalysisPCBDiscrete
    - OilAnalysisFluidAnalog
    - OilAnalysisGasAnalog
    - OilAnalysisPCBAnalog
    - OilAnalysisParticleDiscrete
    - OilAnalysisMetalsAnalog
    - OilAnalysisParticleAnalog
    - OilAnalysisPaperAnalog
    - CompositeSwitchInfo
    - Facility
    - RiskScore
    - FACTSDevice
    - SimpleEndDeviceFunction
    - UndergroundStructure
    - RelativeDisplacement
    - CloudCondition
    - GeosphericAnalog
    - HydrosphericAnalog
    - AtmosphericAnalog
    - SpaceAnalog
    range: TempEquipActionKind
    required: false
  energy_consumer:
    name: energy_consumer
    description: The energy consumer that the energy consumer action is performed
      on
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyConsumerAction.EnergyConsumer
    multivalued: false
    alias: energy_consumer
    owner: EnergyConsumerAction
    domain_of:
    - EnergyConsumerPhase
    - LoadDynamics
    - LoadResponseCharacteristic
    - EnergyConsumerAction
    range: EnergyConsumer
    required: false
  executed_date_time:
    name: executed_date_time
    description: Actual date and time of this switching step.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SwitchingAction.executedDateTime
    multivalued: false
    alias: executed_date_time
    owner: EnergyConsumerAction
    domain_of:
    - SwitchingAction
    range: date
    required: false
  issued_date_time:
    name: issued_date_time
    description: Date and time when the crew was given the instruction to execute
      the action; not applicable if the action is performed by operator remote control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SwitchingAction.issuedDateTime
    multivalued: false
    alias: issued_date_time
    owner: EnergyConsumerAction
    domain_of:
    - SwitchingAction
    - SafetyDocument
    range: date
    required: false
  phases:
    name: phases
    description: Phases of the Switching Action
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:SwitchingAction.phases
    multivalued: false
    alias: phases
    owner: EnergyConsumerAction
    domain_of:
    - Terminal
    - Measurement
    - SwitchingAction
    - Fault
    - TransformerTankEnd
    - ReadingType
    range: PhaseCode
    required: false
  planned_date_time:
    name: planned_date_time
    description: Planned date and time of this switching step.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SwitchingAction.plannedDateTime
    multivalued: false
    alias: planned_date_time
    owner: EnergyConsumerAction
    domain_of:
    - SwitchingAction
    range: date
    required: false
  switching_plan:
    name: switching_plan
    description: The switching plan that is associated with the switching actions.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:SwitchingAction.SwitchingPlan
    multivalued: false
    alias: switching_plan
    owner: EnergyConsumerAction
    domain_of:
    - SwitchingPlanRequest
    - SwitchingOrder
    - WorkTask
    - SwitchingAction
    - SwitchingStepGroup
    - OutagePlan
    - PlannedOutageNotification
    - SafetyDocument
    range: SwitchingPlan
    required: false
  operator:
    name: operator
    description: Operator responsible for this switching step.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SwitchingAction.Operator
    multivalued: false
    alias: operator
    owner: EnergyConsumerAction
    domain_of:
    - SwitchingAction
    range: Operator
    required: false
  crew:
    name: crew
    description: The crew that is assigned to the switching action.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:SwitchingAction.Crew
    multivalued: true
    alias: crew
    owner: EnergyConsumerAction
    domain_of:
    - Location
    - Capability
    - SwitchingAction
    - FieldDispatchHistory
    - Outage
    - WorkAsset
    - CrewMember
    range: Crew
    required: false
  switching_event:
    name: switching_event
    description: The switching event that the switching action is performed on
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SwitchingAction.SwitchingEvent
    multivalued: false
    alias: switching_event
    owner: EnergyConsumerAction
    domain_of:
    - SwitchingAction
    range: SwitchingEvent
    required: false
  switching_step:
    name: switching_step
    description: The switching step that is associated to the switching action.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:SwitchingAction.SwitchingStep
    multivalued: false
    alias: switching_step
    owner: EnergyConsumerAction
    domain_of:
    - SwitchingAction
    - SwitchingStepGroup
    - RevisionHistory
    range: SwitchingStep
    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: EnergyConsumerAction
    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: EnergyConsumerAction
    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: EnergyConsumerAction
    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: EnergyConsumerAction
    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: EnergyConsumerAction
    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: EnergyConsumerAction
    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: EnergyConsumerAction
    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: EnergyConsumerAction
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:EnergyConsumerAction