Skip to content

Class: MarketRun

This class represents an actual instance of a planned market. For example, a Day Ahead market opens with the Bid Submission, ends with the closing of the Bid Submission. The market run represent the whole process. MarketRuns can be defined for markets such as Day Ahead Market, Real Time Market, Hour Ahead Market, Week Ahead Market, etc.

URI: cim:MarketRun

 classDiagram
    class MarketRun
      IdentifiedObject <|-- MarketRun

      MarketRun : alias_name

      MarketRun : description

      MarketRun : diagram_objects

          MarketRun --> DiagramObject : diagram_objects

      MarketRun : execution_type

          MarketRun --> ExecutionType : execution_type

      MarketRun : instance_set

          MarketRun --> InstanceSet : instance_set

      MarketRun : m_rid

      MarketRun : market

          MarketRun --> Market : market

      MarketRun : market_actual_event

          MarketRun --> MarketActualEvent : market_actual_event

      MarketRun : market_approval_time

      MarketRun : market_approved_status

      MarketRun : market_end_time

      MarketRun : market_start_time

      MarketRun : market_type

          MarketRun --> MarketType : market_type

      MarketRun : names

          MarketRun --> Name : names

      MarketRun : planned_market

          MarketRun --> PlannedMarket : planned_market

      MarketRun : properties_cimdata_object

          MarketRun --> ChangeSetMember : properties_cimdata_object

      MarketRun : reported_state

      MarketRun : run_state

      MarketRun : targeting_cimdata_object

          MarketRun --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
execution_type 0..1
ExecutionType		 The execution type; Day Ahead, Intra Day, Real Time Pre-Dispatch, Real Time D... direct
market_approval_time 0..1
date		 Approved time for case direct
market_approved_status 0..1
Boolean		 Set to true when the plan is approved by authority and becomes the official p... direct
market_end_time 0..1
date		 The end time defined as the end of the market, market end time direct
market_start_time 0..1
date		 The start time defined as the beginning of the market, market start time direct
market_type 0..1
MarketType		 The market type, Day Ahead Market or Real Time Market direct
reported_state 0..1
String		 This is the state of market run activity as reported by market systems to the... direct
run_state 0..1
String		 This is the state controlled by market defintion service direct
market 1..1
Market		 direct
market_actual_event 1..*
MarketActualEvent		 All actual events that trigger this market run direct
planned_market 1..1
PlannedMarket		 A planned market could have multiple market runs for the reason that a planne... 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_run range MarketRun
MarketActualEvent market_run range MarketRun
PlannedMarket market_run range MarketRun
DistributedResourceActualEvent market_run range MarketRun
CRRMarket market_run range MarketRun
EnergyMarket market_run range MarketRun

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: MarketRun
description: This class represents an actual instance of a planned market. For example,
  a Day Ahead market opens with the Bid Submission, ends with the closing of the Bid
  Submission. The market run represent the whole process. MarketRuns can be defined
  for markets such as Day Ahead Market, Real Time Market, Hour Ahead Market, Week
  Ahead Market, etc.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  execution_type:
    name: execution_type
    description: "The execution type; Day Ahead, Intra Day, Real Time Pre-Dispatch,\
      \ Real Time Dispatch\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.executionType
    multivalued: false
    domain_of:
    - MarketRun
    range: ExecutionType
    required: false
  market_approval_time:
    name: market_approval_time
    description: "Approved time for case. Identifies the time that the dispatcher\
      \ approved a specific real time unit dispatch case\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.marketApprovalTime
    multivalued: false
    domain_of:
    - MarketRun
    range: date
    required: false
  market_approved_status:
    name: market_approved_status
    description: "Set to true when the plan is approved by authority and becomes the\
      \ official plan for the day ahead market. Identifies the approved case for the\
      \ market for the specified time interval.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.marketApprovedStatus
    multivalued: false
    domain_of:
    - MarketRun
    range: boolean
    required: false
  market_end_time:
    name: market_end_time
    description: "The end time defined as the end of the market, market end time.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.marketEndTime
    multivalued: false
    domain_of:
    - MarketRun
    - PlannedMarket
    range: date
    required: false
  market_start_time:
    name: market_start_time
    description: "The start time defined as the beginning of the market, market start\
      \ time.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.marketStartTime
    multivalued: false
    domain_of:
    - MarketRun
    - PlannedMarket
    range: date
    required: false
  market_type:
    name: market_type
    description: "The market type, Day Ahead Market or Real Time Market.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.marketType
    multivalued: false
    domain_of:
    - MarketRun
    - PlannedMarket
    - Bid
    - MPMTestThreshold
    - DistributionFactorSet
    - Trade
    - InterchangeSchedule
    - PriceDescriptor
    - TradingHubPrice
    - BidPriceCap
    - BilateralTransaction
    - AuxiliaryCost
    range: MarketType
    required: false
  reported_state:
    name: reported_state
    description: "This is the state of market run activity as reported by market systems\
      \ to the market definition services.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.reportedState
    multivalued: false
    domain_of:
    - MarketRun
    range: string
    required: false
  run_state:
    name: run_state
    description: "This is the state controlled by market defintion service.\r\nPossible\
      \ values could be but not limited by: Open, Close.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.runState
    multivalued: false
    domain_of:
    - MarketRun
    range: string
    required: false
  market:
    name: market
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketRun.Market
    multivalued: false
    domain_of:
    - MarketFactors
    - MarketRun
    - MarketProduct
    - ResourceCertification
    range: Market
    required: true
  market_actual_event:
    name: market_actual_event
    description: All actual events that trigger this market run.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.MarketActualEvent
    multivalued: true
    domain_of:
    - MarketRun
    - PlannedMarketEvent
    range: MarketActualEvent
    required: true
  planned_market:
    name: planned_market
    description: A planned market could have multiple market runs for the reason that
      a planned market could have a rerun.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.PlannedMarket
    multivalued: false
    domain_of:
    - MarketRun
    - PlannedMarketEvent
    - MarketPlan
    range: PlannedMarket
    required: true
class_uri: cim:MarketRun

Induced

name: MarketRun
description: This class represents an actual instance of a planned market. For example,
  a Day Ahead market opens with the Bid Submission, ends with the closing of the Bid
  Submission. The market run represent the whole process. MarketRuns can be defined
  for markets such as Day Ahead Market, Real Time Market, Hour Ahead Market, Week
  Ahead Market, etc.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  execution_type:
    name: execution_type
    description: "The execution type; Day Ahead, Intra Day, Real Time Pre-Dispatch,\
      \ Real Time Dispatch\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.executionType
    multivalued: false
    alias: execution_type
    owner: MarketRun
    domain_of:
    - MarketRun
    range: ExecutionType
    required: false
  market_approval_time:
    name: market_approval_time
    description: "Approved time for case. Identifies the time that the dispatcher\
      \ approved a specific real time unit dispatch case\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.marketApprovalTime
    multivalued: false
    alias: market_approval_time
    owner: MarketRun
    domain_of:
    - MarketRun
    range: date
    required: false
  market_approved_status:
    name: market_approved_status
    description: "Set to true when the plan is approved by authority and becomes the\
      \ official plan for the day ahead market. Identifies the approved case for the\
      \ market for the specified time interval.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.marketApprovedStatus
    multivalued: false
    alias: market_approved_status
    owner: MarketRun
    domain_of:
    - MarketRun
    range: boolean
    required: false
  market_end_time:
    name: market_end_time
    description: "The end time defined as the end of the market, market end time.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.marketEndTime
    multivalued: false
    alias: market_end_time
    owner: MarketRun
    domain_of:
    - MarketRun
    - PlannedMarket
    range: date
    required: false
  market_start_time:
    name: market_start_time
    description: "The start time defined as the beginning of the market, market start\
      \ time.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.marketStartTime
    multivalued: false
    alias: market_start_time
    owner: MarketRun
    domain_of:
    - MarketRun
    - PlannedMarket
    range: date
    required: false
  market_type:
    name: market_type
    description: "The market type, Day Ahead Market or Real Time Market.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.marketType
    multivalued: false
    alias: market_type
    owner: MarketRun
    domain_of:
    - MarketRun
    - PlannedMarket
    - Bid
    - MPMTestThreshold
    - DistributionFactorSet
    - Trade
    - InterchangeSchedule
    - PriceDescriptor
    - TradingHubPrice
    - BidPriceCap
    - BilateralTransaction
    - AuxiliaryCost
    range: MarketType
    required: false
  reported_state:
    name: reported_state
    description: "This is the state of market run activity as reported by market systems\
      \ to the market definition services.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.reportedState
    multivalued: false
    alias: reported_state
    owner: MarketRun
    domain_of:
    - MarketRun
    range: string
    required: false
  run_state:
    name: run_state
    description: "This is the state controlled by market defintion service.\r\nPossible\
      \ values could be but not limited by: Open, Close.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.runState
    multivalued: false
    alias: run_state
    owner: MarketRun
    domain_of:
    - MarketRun
    range: string
    required: false
  market:
    name: market
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketRun.Market
    multivalued: false
    alias: market
    owner: MarketRun
    domain_of:
    - MarketFactors
    - MarketRun
    - MarketProduct
    - ResourceCertification
    range: Market
    required: true
  market_actual_event:
    name: market_actual_event
    description: All actual events that trigger this market run.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.MarketActualEvent
    multivalued: true
    alias: market_actual_event
    owner: MarketRun
    domain_of:
    - MarketRun
    - PlannedMarketEvent
    range: MarketActualEvent
    required: true
  planned_market:
    name: planned_market
    description: A planned market could have multiple market runs for the reason that
      a planned market could have a rerun.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketRun.PlannedMarket
    multivalued: false
    alias: planned_market
    owner: MarketRun
    domain_of:
    - MarketRun
    - PlannedMarketEvent
    - MarketPlan
    range: PlannedMarket
    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: MarketRun
    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: MarketRun
    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: MarketRun
    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: MarketRun
    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: MarketRun
    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: MarketRun
    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: MarketRun
    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: MarketRun
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:MarketRun