Skip to content

Class: CommodityPrice

The CommodityPrice class is used to define the price of a commodity during a given time interval. The interval may be long, e.g. a year, or very short, e.g. 5 minutes. There will be many instances of the CommodityPrice class for each instance of the CommodityDefinition to which it is associated. Note that there may be more than once price associated with a given interval and these variances are described by the association (or associations) with the PriceDescriptor class.

URI: cim:CommodityPrice

 classDiagram
    class CommodityPrice
      CommodityPrice : commodity_definition

          CommodityPrice --> CommodityDefinition : commodity_definition

      CommodityPrice : pnode_clearing

          CommodityPrice --> PnodeClearing : pnode_clearing

      CommodityPrice : price_descriptor

          CommodityPrice --> PriceDescriptor : price_descriptor

      CommodityPrice : time_interval_period

          CommodityPrice --> DateTimeInterval : time_interval_period

      CommodityPrice : value

Slots

Name Cardinality and Range Description Inheritance
time_interval_period 0..1
DateTimeInterval
The time interval over which the CommodityPrice is valid, using the standard ... direct
value 0..1
Float
The price of the Commodity, expressed as a floating point value with the curr... direct
price_descriptor 1..1
PriceDescriptor
direct
commodity_definition 1..1
CommodityDefinition
direct
pnode_clearing 0..1
PnodeClearing
direct

Usages

used by used in type used
CommodityDefinition commodity_price range CommodityPrice
PnodeClearing commodity_price range CommodityPrice
PriceDescriptor commodity_price range CommodityPrice

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: CommodityPrice
description: The CommodityPrice class is used to define the price of a commodity during
  a given time interval.  The interval may be long, e.g. a year, or very short, e.g.
  5 minutes.  There will be many instances of the CommodityPrice class for each instance
  of the CommodityDefinition to which it is associated.  Note that there may be more
  than once price associated with a given interval and these variances are described
  by the association (or associations) with the PriceDescriptor class.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
attributes:
  time_interval_period:
    name: time_interval_period
    description: The time interval over which the CommodityPrice is valid, using the
      standard conventions associated with the DateTimeInterval class.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityPrice.timeIntervalPeriod
    multivalued: false
    domain_of:
    - CommodityPrice
    range: DateTimeInterval
    required: false
  value:
    name: value
    description: The price of the Commodity, expressed as a floating point value with
      the currency and unit of measure defined in the associated CommodityDefinition
      class.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CommodityPrice.value
    multivalued: false
    domain_of:
    - VoltagePerReactivePower
    - Length
    - ConductancePerLength
    - VolumeFlowRate
    - Volume
    - Voltage
    - Temperature
    - Admittance
    - Impedance
    - CostPerVolume
    - SusceptancePerLength
    - Money
    - Minutes
    - FloatQuantity
    - CostPerEnergyUnit
    - PerCent
    - IntegerQuantity
    - ApparentPower
    - WaterLevel
    - Displacement
    - Damping
    - Seconds
    - ResistancePerLength
    - Inductance
    - AngleDegrees
    - CostRate
    - Speed
    - Capacitance
    - PU
    - Pressure
    - KiloActivePower
    - ReactivePower
    - StringQuantity
    - ActivePowerChangeRate
    - Hours
    - Conductance
    - RotationSpeed
    - CurrentFlow
    - Frequency
    - AngleRadians
    - ActivePower
    - ReactancePerLength
    - Resistance
    - Reactance
    - Susceptance
    - RealEnergy
    - Classification
    - HeatRate
    - Emission
    - CostPerHeatUnit
    - ActivePowerPerFrequency
    - InductancePerLength
    - CapacitancePerLength
    - DecimalQuantity
    - Area
    - ActivePowerPerCurrentFlow
    - Mass
    - Status
    - UserAttribute
    - AccountingUnit
    - BaseReading
    - EndDeviceEventDetail
    - MeterMultiplier
    - RegularTimePoint
    - AnalogValue
    - AnalogLimit
    - CommodityPrice
    - ChargeProfileData
    - StringMeasurementValue
    - Command
    - DiscreteValue
    - ValueToAlias
    - ServiceMultiplier
    - AnalyticScore
    - IrregularTimePoint
    - ActivePowerLimit
    - ApparentPowerLimit
    - CurrentLimit
    - VoltageLimit
    - AccumulatorValue
    - AccumulatorLimit
    - SetPoint
    - ScheduledActivePowerLimitValue
    - ScheduledApparentPowerLimitValue
    - ScheduledCurrentLimitValue
    - ScheduledVoltageLimitValue
    - MagneticField
    - ParticulateDensity
    - Bearing
    - PumpingShutDownCostSchedule
    - PumpingLevelSchedule
    - HourlyPreDispatchSchedule
    - PumpingCostSchedule
    - OpenTieSchedule
    - WheelingReferenceSchedule
    range: float
    required: false
  price_descriptor:
    name: price_descriptor
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityPrice.PriceDescriptor
    multivalued: false
    domain_of:
    - CommodityPrice
    range: PriceDescriptor
    required: true
  commodity_definition:
    name: commodity_definition
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CommodityPrice.CommodityDefinition
    multivalued: false
    domain_of:
    - MarketProduct
    - RTO
    - Pnode
    - CommodityPrice
    range: CommodityDefinition
    required: true
  pnode_clearing:
    name: pnode_clearing
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CommodityPrice.PnodeClearing
    multivalued: false
    domain_of:
    - PnodeResults
    - CommodityPrice
    range: PnodeClearing
    required: false
class_uri: cim:CommodityPrice

Induced

name: CommodityPrice
description: The CommodityPrice class is used to define the price of a commodity during
  a given time interval.  The interval may be long, e.g. a year, or very short, e.g.
  5 minutes.  There will be many instances of the CommodityPrice class for each instance
  of the CommodityDefinition to which it is associated.  Note that there may be more
  than once price associated with a given interval and these variances are described
  by the association (or associations) with the PriceDescriptor class.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
attributes:
  time_interval_period:
    name: time_interval_period
    description: The time interval over which the CommodityPrice is valid, using the
      standard conventions associated with the DateTimeInterval class.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityPrice.timeIntervalPeriod
    multivalued: false
    alias: time_interval_period
    owner: CommodityPrice
    domain_of:
    - CommodityPrice
    range: DateTimeInterval
    required: false
  value:
    name: value
    description: The price of the Commodity, expressed as a floating point value with
      the currency and unit of measure defined in the associated CommodityDefinition
      class.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CommodityPrice.value
    multivalued: false
    alias: value
    owner: CommodityPrice
    domain_of:
    - VoltagePerReactivePower
    - Length
    - ConductancePerLength
    - VolumeFlowRate
    - Volume
    - Voltage
    - Temperature
    - Admittance
    - Impedance
    - CostPerVolume
    - SusceptancePerLength
    - Money
    - Minutes
    - FloatQuantity
    - CostPerEnergyUnit
    - PerCent
    - IntegerQuantity
    - ApparentPower
    - WaterLevel
    - Displacement
    - Damping
    - Seconds
    - ResistancePerLength
    - Inductance
    - AngleDegrees
    - CostRate
    - Speed
    - Capacitance
    - PU
    - Pressure
    - KiloActivePower
    - ReactivePower
    - StringQuantity
    - ActivePowerChangeRate
    - Hours
    - Conductance
    - RotationSpeed
    - CurrentFlow
    - Frequency
    - AngleRadians
    - ActivePower
    - ReactancePerLength
    - Resistance
    - Reactance
    - Susceptance
    - RealEnergy
    - Classification
    - HeatRate
    - Emission
    - CostPerHeatUnit
    - ActivePowerPerFrequency
    - InductancePerLength
    - CapacitancePerLength
    - DecimalQuantity
    - Area
    - ActivePowerPerCurrentFlow
    - Mass
    - Status
    - UserAttribute
    - AccountingUnit
    - BaseReading
    - EndDeviceEventDetail
    - MeterMultiplier
    - RegularTimePoint
    - AnalogValue
    - AnalogLimit
    - CommodityPrice
    - ChargeProfileData
    - StringMeasurementValue
    - Command
    - DiscreteValue
    - ValueToAlias
    - ServiceMultiplier
    - AnalyticScore
    - IrregularTimePoint
    - ActivePowerLimit
    - ApparentPowerLimit
    - CurrentLimit
    - VoltageLimit
    - AccumulatorValue
    - AccumulatorLimit
    - SetPoint
    - ScheduledActivePowerLimitValue
    - ScheduledApparentPowerLimitValue
    - ScheduledCurrentLimitValue
    - ScheduledVoltageLimitValue
    - MagneticField
    - ParticulateDensity
    - Bearing
    - PumpingShutDownCostSchedule
    - PumpingLevelSchedule
    - HourlyPreDispatchSchedule
    - PumpingCostSchedule
    - OpenTieSchedule
    - WheelingReferenceSchedule
    range: float
    required: false
  price_descriptor:
    name: price_descriptor
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityPrice.PriceDescriptor
    multivalued: false
    alias: price_descriptor
    owner: CommodityPrice
    domain_of:
    - CommodityPrice
    range: PriceDescriptor
    required: true
  commodity_definition:
    name: commodity_definition
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CommodityPrice.CommodityDefinition
    multivalued: false
    alias: commodity_definition
    owner: CommodityPrice
    domain_of:
    - MarketProduct
    - RTO
    - Pnode
    - CommodityPrice
    range: CommodityDefinition
    required: true
  pnode_clearing:
    name: pnode_clearing
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CommodityPrice.PnodeClearing
    multivalued: false
    alias: pnode_clearing
    owner: CommodityPrice
    domain_of:
    - PnodeResults
    - CommodityPrice
    range: PnodeClearing
    required: false
class_uri: cim:CommodityPrice