Class: MarketProduct

A product traded by an RTO (e.g. energy, 10 minute spinning reserve). Ancillary service product examples include: Regulation, Regulation Up, Regulation Down, Spinning Reserve, Non-Spinning Reserve, etc.

URI: cim:MarketProduct

 classDiagram
    class MarketProduct
      IdentifiedObject <|-- MarketProduct

      MarketProduct : alias_name

      MarketProduct : bid_error

          MarketProduct --> BidError : bid_error

      MarketProduct : bid_price_cap

          MarketProduct --> BidPriceCap : bid_price_cap

      MarketProduct : commodity_definition

          MarketProduct --> CommodityDefinition : commodity_definition

      MarketProduct : description

      MarketProduct : diagram_objects

          MarketProduct --> DiagramObject : diagram_objects

      MarketProduct : instance_set

          MarketProduct --> InstanceSet : instance_set

      MarketProduct : m_rid

      MarketProduct : market

          MarketProduct --> Market : market

      MarketProduct : market_product_type

          MarketProduct --> MarketProductType : market_product_type

      MarketProduct : market_region_results

          MarketProduct --> MarketRegionResults : market_region_results

      MarketProduct : names

          MarketProduct --> Name : names

      MarketProduct : product_bids

          MarketProduct --> ProductBid : product_bids

      MarketProduct : properties_cimdata_object

          MarketProduct --> ChangeSetMember : properties_cimdata_object

      MarketProduct : ramp_interval

      MarketProduct : reserve_reqs

          MarketProduct --> ReserveReq : reserve_reqs

      MarketProduct : resource_award_instruction

          MarketProduct --> ResourceAwardInstruction : resource_award_instruction

      MarketProduct : targeting_cimdata_object

          MarketProduct --> ChangeSetMember : targeting_cimdata_object

Inheritance

IdentifiedObject
- MarketProduct

Slots

Name	Cardinality and Range	Description	Inheritance
market_product_type	0..1 MarketProductType	Market product type examples:
direct
ramp_interval	0..1 Float	Ramping time interval for the specific market product type specified by marke...	direct
market_region_results	0..1 MarketRegionResults		direct
bid_price_cap	0..* BidPriceCap		direct
market	0..1 Market		direct
bid_error	0..* BidError		direct
resource_award_instruction	0..* ResourceAwardInstruction		direct
product_bids	0..* ProductBid		direct
commodity_definition	0..* CommodityDefinition		direct
reserve_reqs	0..* ReserveReq	Market product associated with reserve requirement must be a reserve or regul...	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
Market	market_products	range	MarketProduct
CommodityDefinition	market_product	range	MarketProduct
ProductBid	market_product	range	MarketProduct
BidError	market_product	range	MarketProduct
CRRMarket	market_products	range	MarketProduct
EnergyMarket	market_products	range	MarketProduct
ReserveReq	market_product	range	MarketProduct
MarketRegionResults	market_product	range	MarketProduct
BidPriceCap	market_product	range	MarketProduct
ResourceAwardInstruction	market_product	range	MarketProduct

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: MarketProduct
description: 'A product traded by an RTO (e.g. energy, 10 minute spinning reserve).  Ancillary
  service product examples include: Regulation, Regulation Up, Regulation Down, Spinning
  Reserve, Non-Spinning Reserve, etc.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  market_product_type:
    name: market_product_type
    description: "Market product type examples:\r\n\r\nEN (Energy)\r\nRU (Regulation\
      \ Up)\r\nRD (Regulation Dn)\r\nSR (Spinning Reserve)\r\nNR (Non-Spinning Reserve)\r\
      \nRC (RUC)\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.marketProductType
    multivalued: false
    domain_of:
    - MarketProduct
    - RUCAwardInstruction
    range: MarketProductType
    required: false
  ramp_interval:
    name: ramp_interval
    description: Ramping time interval for the specific market product type specified
      by marketProductType attribute. For example, if marketProductType = EN (from
      enumeration MarketProductType), then the rampInterval is the ramping time interval
      for Energy.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.rampInterval
    multivalued: false
    domain_of:
    - MarketProduct
    range: float
    required: false
  market_region_results:
    name: market_region_results
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.MarketRegionResults
    multivalued: false
    domain_of:
    - MarketProduct
    - MarketRegion
    - AncillaryServiceClearing
    range: MarketRegionResults
    required: false
  bid_price_cap:
    name: bid_price_cap
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.BidPriceCap
    multivalued: true
    domain_of:
    - MarketProduct
    range: BidPriceCap
    required: false
  market:
    name: market
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketProduct.Market
    multivalued: false
    domain_of:
    - MarketFactors
    - MarketRun
    - MarketProduct
    - ResourceCertification
    range: Market
    required: false
  bid_error:
    name: bid_error
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.BidError
    multivalued: true
    domain_of:
    - MarketProduct
    - ResourceBid
    range: BidError
    required: false
  resource_award_instruction:
    name: resource_award_instruction
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketProduct.ResourceAwardInstruction
    multivalued: true
    domain_of:
    - RegisteredResource
    - MarketProduct
    - ResourceAwardClearing
    - SelfScheduleBreakdown
    range: ResourceAwardInstruction
    required: false
  product_bids:
    name: product_bids
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.ProductBids
    multivalued: true
    domain_of:
    - MarketProduct
    - Bid
    range: ProductBid
    required: false
  commodity_definition:
    name: commodity_definition
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.CommodityDefinition
    multivalued: true
    domain_of:
    - MarketProduct
    - RTO
    - Pnode
    - CommodityPrice
    range: CommodityDefinition
    required: false
  reserve_reqs:
    name: reserve_reqs
    description: Market product associated with reserve requirement must be a reserve
      or regulation product.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.ReserveReqs
    multivalued: true
    domain_of:
    - MarketProduct
    range: ReserveReq
    required: false
class_uri: cim:MarketProduct

Induced

name: MarketProduct
description: 'A product traded by an RTO (e.g. energy, 10 minute spinning reserve).  Ancillary
  service product examples include: Regulation, Regulation Up, Regulation Down, Spinning
  Reserve, Non-Spinning Reserve, etc.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  market_product_type:
    name: market_product_type
    description: "Market product type examples:\r\n\r\nEN (Energy)\r\nRU (Regulation\
      \ Up)\r\nRD (Regulation Dn)\r\nSR (Spinning Reserve)\r\nNR (Non-Spinning Reserve)\r\
      \nRC (RUC)\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.marketProductType
    multivalued: false
    alias: market_product_type
    owner: MarketProduct
    domain_of:
    - MarketProduct
    - RUCAwardInstruction
    range: MarketProductType
    required: false
  ramp_interval:
    name: ramp_interval
    description: Ramping time interval for the specific market product type specified
      by marketProductType attribute. For example, if marketProductType = EN (from
      enumeration MarketProductType), then the rampInterval is the ramping time interval
      for Energy.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.rampInterval
    multivalued: false
    alias: ramp_interval
    owner: MarketProduct
    domain_of:
    - MarketProduct
    range: float
    required: false
  market_region_results:
    name: market_region_results
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.MarketRegionResults
    multivalued: false
    alias: market_region_results
    owner: MarketProduct
    domain_of:
    - MarketProduct
    - MarketRegion
    - AncillaryServiceClearing
    range: MarketRegionResults
    required: false
  bid_price_cap:
    name: bid_price_cap
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.BidPriceCap
    multivalued: true
    alias: bid_price_cap
    owner: MarketProduct
    domain_of:
    - MarketProduct
    range: BidPriceCap
    required: false
  market:
    name: market
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketProduct.Market
    multivalued: false
    alias: market
    owner: MarketProduct
    domain_of:
    - MarketFactors
    - MarketRun
    - MarketProduct
    - ResourceCertification
    range: Market
    required: false
  bid_error:
    name: bid_error
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.BidError
    multivalued: true
    alias: bid_error
    owner: MarketProduct
    domain_of:
    - MarketProduct
    - ResourceBid
    range: BidError
    required: false
  resource_award_instruction:
    name: resource_award_instruction
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketProduct.ResourceAwardInstruction
    multivalued: true
    alias: resource_award_instruction
    owner: MarketProduct
    domain_of:
    - RegisteredResource
    - MarketProduct
    - ResourceAwardClearing
    - SelfScheduleBreakdown
    range: ResourceAwardInstruction
    required: false
  product_bids:
    name: product_bids
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.ProductBids
    multivalued: true
    alias: product_bids
    owner: MarketProduct
    domain_of:
    - MarketProduct
    - Bid
    range: ProductBid
    required: false
  commodity_definition:
    name: commodity_definition
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.CommodityDefinition
    multivalued: true
    alias: commodity_definition
    owner: MarketProduct
    domain_of:
    - MarketProduct
    - RTO
    - Pnode
    - CommodityPrice
    range: CommodityDefinition
    required: false
  reserve_reqs:
    name: reserve_reqs
    description: Market product associated with reserve requirement must be a reserve
      or regulation product.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketProduct.ReserveReqs
    multivalued: true
    alias: reserve_reqs
    owner: MarketProduct
    domain_of:
    - MarketProduct
    range: ReserveReq
    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: MarketProduct
    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: MarketProduct
    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: MarketProduct
    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: MarketProduct
    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: MarketProduct
    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: MarketProduct
    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: MarketProduct
    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: MarketProduct
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:MarketProduct