Skip to content

Class: CommodityDefinition

Commodities in the context of IEC 62325 are MarketProducts (energy, regulation, reserve, etc) traded at a specific location, which in this case is a Pnode (either a specific pricing node or a pricing area or zone defined as a collection of pricing nodes). The CommodityDefinition is a container for these two parameters, plus the unit of measure and the currency in which the Commodity is traded. Each CommodityDefinition should be relatively static; defined once and rarely changed.

URI: cim:CommodityDefinition

 classDiagram
    class CommodityDefinition
      IdentifiedObject <|-- CommodityDefinition

      CommodityDefinition : alias_name

      CommodityDefinition : commodity_currency

          CommodityDefinition --> Currency : commodity_currency

      CommodityDefinition : commodity_price

          CommodityDefinition --> CommodityPrice : commodity_price

      CommodityDefinition : commodity_unit

          CommodityDefinition --> UnitSymbol : commodity_unit

      CommodityDefinition : commodity_unit_multiplier

          CommodityDefinition --> UnitMultiplier : commodity_unit_multiplier

      CommodityDefinition : description

      CommodityDefinition : diagram_objects

          CommodityDefinition --> DiagramObject : diagram_objects

      CommodityDefinition : instance_set

          CommodityDefinition --> InstanceSet : instance_set

      CommodityDefinition : m_rid

      CommodityDefinition : market_product

          CommodityDefinition --> MarketProduct : market_product

      CommodityDefinition : names

          CommodityDefinition --> Name : names

      CommodityDefinition : pnode

          CommodityDefinition --> Pnode : pnode

      CommodityDefinition : properties_cimdata_object

          CommodityDefinition --> ChangeSetMember : properties_cimdata_object

      CommodityDefinition : rto

          CommodityDefinition --> RTO : rto

      CommodityDefinition : targeting_cimdata_object

          CommodityDefinition --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
commodity_currency 0..1
Currency		 The currency in which the Commodity is traded, using the standard conventions... direct
commodity_unit 0..1
UnitSymbol		 The unit of measure in which the Commodity is traded, using the standard conv... direct
commodity_unit_multiplier 0..1
UnitMultiplier		 The unit multiplier, e direct
market_product 1..1
MarketProduct		 direct
pnode 1..1
Pnode		 direct
rto 1..1
RTO		 direct
commodity_price 1..*
CommodityPrice		 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
MarketProduct commodity_definition range CommodityDefinition
RTO commodity_definition range CommodityDefinition
AggregatedPnode commodity_definition range CommodityDefinition
Pnode commodity_definition range CommodityDefinition
IndividualPnode commodity_definition range CommodityDefinition
CongestionArea commodity_definition range CommodityDefinition
CommodityPrice commodity_definition range CommodityDefinition

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: CommodityDefinition
description: Commodities in the context of IEC 62325 are MarketProducts (energy, regulation,
  reserve, etc) traded at a specific location, which in this case is a Pnode (either
  a specific pricing node or a pricing area or zone defined as a collection of pricing
  nodes).  The CommodityDefinition is a container for these two parameters, plus the
  unit of measure and the currency in which the Commodity is traded.  Each CommodityDefinition
  should be relatively static; defined once and rarely changed.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  commodity_currency:
    name: commodity_currency
    description: The currency in which the Commodity is traded, using the standard
      conventions associated with the Currency enumeration.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.commodityCurrency
    multivalued: false
    domain_of:
    - CommodityDefinition
    range: Currency
    required: false
  commodity_unit:
    name: commodity_unit
    description: The unit of measure in which the Commodity is traded, using the standard
      conventions associated with the UnitSymbol enumeration.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.commodityUnit
    multivalued: false
    domain_of:
    - CommodityDefinition
    range: UnitSymbol
    required: false
  commodity_unit_multiplier:
    name: commodity_unit_multiplier
    description: The unit multiplier, e.g. "k" to convert the unit "W-h" to "kW-h",
      using the standard conventions associated with the UnitMultiplier enumeration.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.commodityUnitMultiplier
    multivalued: false
    domain_of:
    - CommodityDefinition
    range: UnitMultiplier
    required: false
  market_product:
    name: market_product
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.MarketProduct
    multivalued: false
    domain_of:
    - CommodityDefinition
    - ProductBid
    - BidError
    - ReserveReq
    - MarketRegionResults
    - BidPriceCap
    - ResourceAwardInstruction
    range: MarketProduct
    required: true
  pnode:
    name: pnode
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CommodityDefinition.Pnode
    multivalued: false
    domain_of:
    - RegisteredResource
    - CommodityDefinition
    - MktMeasurement
    - SubControlArea
    - Trade
    - AggregateNode
    - OrgPnodeAllocation
    - PnodeResults
    - ExPostPricingResults
    range: Pnode
    required: true
  rto:
    name: rto
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.RTO
    multivalued: false
    domain_of:
    - CommodityDefinition
    - Pnode
    - SubControlArea
    - AdjacentCASet
    - HostControlArea
    - ContractRight
    - TransmissionRightChain
    - FuelRegion
    - LocalReliabilityArea
    - SecurityConstraints
    - MktConnectivityNode
    - AggregateNode
    - SecurityConstraintSum
    - EnergyMarket
    - MSSAggregation
    range: RTO
    required: true
  commodity_price:
    name: commodity_price
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.CommodityPrice
    multivalued: true
    domain_of:
    - CommodityDefinition
    - PnodeClearing
    - PriceDescriptor
    range: CommodityPrice
    required: true
class_uri: cim:CommodityDefinition

Induced

name: CommodityDefinition
description: Commodities in the context of IEC 62325 are MarketProducts (energy, regulation,
  reserve, etc) traded at a specific location, which in this case is a Pnode (either
  a specific pricing node or a pricing area or zone defined as a collection of pricing
  nodes).  The CommodityDefinition is a container for these two parameters, plus the
  unit of measure and the currency in which the Commodity is traded.  Each CommodityDefinition
  should be relatively static; defined once and rarely changed.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  commodity_currency:
    name: commodity_currency
    description: The currency in which the Commodity is traded, using the standard
      conventions associated with the Currency enumeration.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.commodityCurrency
    multivalued: false
    alias: commodity_currency
    owner: CommodityDefinition
    domain_of:
    - CommodityDefinition
    range: Currency
    required: false
  commodity_unit:
    name: commodity_unit
    description: The unit of measure in which the Commodity is traded, using the standard
      conventions associated with the UnitSymbol enumeration.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.commodityUnit
    multivalued: false
    alias: commodity_unit
    owner: CommodityDefinition
    domain_of:
    - CommodityDefinition
    range: UnitSymbol
    required: false
  commodity_unit_multiplier:
    name: commodity_unit_multiplier
    description: The unit multiplier, e.g. "k" to convert the unit "W-h" to "kW-h",
      using the standard conventions associated with the UnitMultiplier enumeration.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.commodityUnitMultiplier
    multivalued: false
    alias: commodity_unit_multiplier
    owner: CommodityDefinition
    domain_of:
    - CommodityDefinition
    range: UnitMultiplier
    required: false
  market_product:
    name: market_product
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.MarketProduct
    multivalued: false
    alias: market_product
    owner: CommodityDefinition
    domain_of:
    - CommodityDefinition
    - ProductBid
    - BidError
    - ReserveReq
    - MarketRegionResults
    - BidPriceCap
    - ResourceAwardInstruction
    range: MarketProduct
    required: true
  pnode:
    name: pnode
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CommodityDefinition.Pnode
    multivalued: false
    alias: pnode
    owner: CommodityDefinition
    domain_of:
    - RegisteredResource
    - CommodityDefinition
    - MktMeasurement
    - SubControlArea
    - Trade
    - AggregateNode
    - OrgPnodeAllocation
    - PnodeResults
    - ExPostPricingResults
    range: Pnode
    required: true
  rto:
    name: rto
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.RTO
    multivalued: false
    alias: rto
    owner: CommodityDefinition
    domain_of:
    - CommodityDefinition
    - Pnode
    - SubControlArea
    - AdjacentCASet
    - HostControlArea
    - ContractRight
    - TransmissionRightChain
    - FuelRegion
    - LocalReliabilityArea
    - SecurityConstraints
    - MktConnectivityNode
    - AggregateNode
    - SecurityConstraintSum
    - EnergyMarket
    - MSSAggregation
    range: RTO
    required: true
  commodity_price:
    name: commodity_price
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CommodityDefinition.CommodityPrice
    multivalued: true
    alias: commodity_price
    owner: CommodityDefinition
    domain_of:
    - CommodityDefinition
    - PnodeClearing
    - PriceDescriptor
    range: CommodityPrice
    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: CommodityDefinition
    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: CommodityDefinition
    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: CommodityDefinition
    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: CommodityDefinition
    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: CommodityDefinition
    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: CommodityDefinition
    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: CommodityDefinition
    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: CommodityDefinition
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:CommodityDefinition