Skip to content

Class: EnergyPriceIndex

An Energy Price Index for each Resource is valid for a period (e.g. daily) that is identified by a Valid Period Start Time and a Valid Period End Time. An Energy Price Index is in $/MWh.

URI: cim:EnergyPriceIndex

 classDiagram
    class EnergyPriceIndex
      IdentifiedObject <|-- EnergyPriceIndex

      EnergyPriceIndex : alias_name

      EnergyPriceIndex : description

      EnergyPriceIndex : diagram_objects

          EnergyPriceIndex --> DiagramObject : diagram_objects

      EnergyPriceIndex : energy_price_index

      EnergyPriceIndex : energy_price_index_type

          EnergyPriceIndex --> EnergyPriceIndexType : energy_price_index_type

      EnergyPriceIndex : instance_set

          EnergyPriceIndex --> InstanceSet : instance_set

      EnergyPriceIndex : last_modified

      EnergyPriceIndex : m_rid

      EnergyPriceIndex : names

          EnergyPriceIndex --> Name : names

      EnergyPriceIndex : properties_cimdata_object

          EnergyPriceIndex --> ChangeSetMember : properties_cimdata_object

      EnergyPriceIndex : registered_generator

          EnergyPriceIndex --> RegisteredGenerator : registered_generator

      EnergyPriceIndex : targeting_cimdata_object

          EnergyPriceIndex --> ChangeSetMember : targeting_cimdata_object

      EnergyPriceIndex : valid_period

          EnergyPriceIndex --> DateTimeInterval : valid_period

Inheritance

Slots

Name Cardinality and Range Description Inheritance
energy_price_index 0..1
Float		 Energy price index
direct
energy_price_index_type 0..1
EnergyPriceIndexType		 EPI type such as wholesale or retail direct
last_modified 0..1
date		 Time updated
direct
valid_period 0..1
DateTimeInterval		 Valid period for which the energy price index is valid direct
registered_generator 1..1
RegisteredGenerator		 direct
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
RegisteredGenerator energy_price_index range EnergyPriceIndex
CombinedCycleConfiguration energy_price_index range EnergyPriceIndex

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: EnergyPriceIndex
description: An Energy Price Index for each Resource is valid for a period (e.g. daily)
  that is identified by a Valid Period Start Time and a Valid Period End Time. An
  Energy Price Index is in $/MWh.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  energy_price_index:
    name: energy_price_index
    description: "Energy price index\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyPriceIndex.energyPriceIndex
    multivalued: false
    domain_of:
    - RegisteredGenerator
    - EnergyPriceIndex
    range: float
    required: false
  energy_price_index_type:
    name: energy_price_index_type
    description: EPI type such as wholesale or retail
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EnergyPriceIndex.energyPriceIndexType
    multivalued: false
    domain_of:
    - EnergyPriceIndex
    range: EnergyPriceIndexType
    required: false
  last_modified:
    name: last_modified
    description: "Time updated\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyPriceIndex.lastModified
    multivalued: false
    domain_of:
    - RegisteredResource
    - SchedulingCoordinator
    - Trade
    - FuelRegion
    - EnergyPriceIndex
    range: date
    required: false
  valid_period:
    name: valid_period
    description: Valid period for which the energy price index is valid.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyPriceIndex.validPeriod
    multivalued: false
    domain_of:
    - AvailablityPlan
    - EnergyPriceIndex
    range: DateTimeInterval
    required: false
  registered_generator:
    name: registered_generator
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyPriceIndex.RegisteredGenerator
    multivalued: false
    domain_of:
    - Trade
    - FuelRegion
    - LocalReliabilityArea
    - GeneratingBid
    - StartUpTimeCurve
    - AuxiliaryObject
    - EnergyPriceIndex
    - FuelCostCurve
    - MktHeatRateCurve
    - RMRStartUpEnergyCurve
    - RMRStartUpTimeCurve
    - StartUpEnergyCurve
    - RegulatingLimit
    - StartUpFuelCurve
    - RMRStartUpCostCurve
    - RMRStartUpFuelCurve
    - RMRHeatRateCurve
    range: RegisteredGenerator
    required: true
class_uri: cim:EnergyPriceIndex

Induced

name: EnergyPriceIndex
description: An Energy Price Index for each Resource is valid for a period (e.g. daily)
  that is identified by a Valid Period Start Time and a Valid Period End Time. An
  Energy Price Index is in $/MWh.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  energy_price_index:
    name: energy_price_index
    description: "Energy price index\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyPriceIndex.energyPriceIndex
    multivalued: false
    alias: energy_price_index
    owner: EnergyPriceIndex
    domain_of:
    - RegisteredGenerator
    - EnergyPriceIndex
    range: float
    required: false
  energy_price_index_type:
    name: energy_price_index_type
    description: EPI type such as wholesale or retail
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EnergyPriceIndex.energyPriceIndexType
    multivalued: false
    alias: energy_price_index_type
    owner: EnergyPriceIndex
    domain_of:
    - EnergyPriceIndex
    range: EnergyPriceIndexType
    required: false
  last_modified:
    name: last_modified
    description: "Time updated\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyPriceIndex.lastModified
    multivalued: false
    alias: last_modified
    owner: EnergyPriceIndex
    domain_of:
    - RegisteredResource
    - SchedulingCoordinator
    - Trade
    - FuelRegion
    - EnergyPriceIndex
    range: date
    required: false
  valid_period:
    name: valid_period
    description: Valid period for which the energy price index is valid.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyPriceIndex.validPeriod
    multivalued: false
    alias: valid_period
    owner: EnergyPriceIndex
    domain_of:
    - AvailablityPlan
    - EnergyPriceIndex
    range: DateTimeInterval
    required: false
  registered_generator:
    name: registered_generator
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnergyPriceIndex.RegisteredGenerator
    multivalued: false
    alias: registered_generator
    owner: EnergyPriceIndex
    domain_of:
    - Trade
    - FuelRegion
    - LocalReliabilityArea
    - GeneratingBid
    - StartUpTimeCurve
    - AuxiliaryObject
    - EnergyPriceIndex
    - FuelCostCurve
    - MktHeatRateCurve
    - RMRStartUpEnergyCurve
    - RMRStartUpTimeCurve
    - StartUpEnergyCurve
    - RegulatingLimit
    - StartUpFuelCurve
    - RMRStartUpCostCurve
    - RMRStartUpFuelCurve
    - RMRHeatRateCurve
    range: RegisteredGenerator
    required: true
  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: EnergyPriceIndex
    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: EnergyPriceIndex
    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: EnergyPriceIndex
    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: EnergyPriceIndex
    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: EnergyPriceIndex
    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: EnergyPriceIndex
    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: EnergyPriceIndex
    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: EnergyPriceIndex
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:EnergyPriceIndex