Skip to content

Class: MarketPlan

This class identifies a set of planned markets.

URI: cim:MarketPlan

 classDiagram
    class MarketPlan
      IdentifiedObject <|-- MarketPlan

      MarketPlan : alias_name

      MarketPlan : description

      MarketPlan : diagram_objects

          MarketPlan --> DiagramObject : diagram_objects

      MarketPlan : instance_set

          MarketPlan --> InstanceSet : instance_set

      MarketPlan : m_rid

      MarketPlan : names

          MarketPlan --> Name : names

      MarketPlan : planned_market

          MarketPlan --> PlannedMarket : planned_market

      MarketPlan : properties_cimdata_object

          MarketPlan --> ChangeSetMember : properties_cimdata_object

      MarketPlan : targeting_cimdata_object

          MarketPlan --> ChangeSetMember : targeting_cimdata_object

      MarketPlan : trading_day

Inheritance

Slots

Name Cardinality and Range Description Inheritance
trading_day 0..1
date		 Planned market trading day direct
planned_market 1..*
PlannedMarket		 A market plan has a number of markets (DA, HA, RT) 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
PlannedMarket market_plan range MarketPlan

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: MarketPlan
description: This class identifies a set of planned markets.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  trading_day:
    name: trading_day
    description: "Planned market trading day.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketPlan.tradingDay
    multivalued: false
    domain_of:
    - Market
    - MarketPlan
    range: date
    required: false
  planned_market:
    name: planned_market
    description: A market plan has a number of markets (DA, HA, RT).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketPlan.PlannedMarket
    multivalued: true
    domain_of:
    - MarketRun
    - PlannedMarketEvent
    - MarketPlan
    range: PlannedMarket
    required: true
class_uri: cim:MarketPlan

Induced

name: MarketPlan
description: This class identifies a set of planned markets.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  trading_day:
    name: trading_day
    description: "Planned market trading day.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketPlan.tradingDay
    multivalued: false
    alias: trading_day
    owner: MarketPlan
    domain_of:
    - Market
    - MarketPlan
    range: date
    required: false
  planned_market:
    name: planned_market
    description: A market plan has a number of markets (DA, HA, RT).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketPlan.PlannedMarket
    multivalued: true
    alias: planned_market
    owner: MarketPlan
    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: MarketPlan
    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: MarketPlan
    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: MarketPlan
    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: MarketPlan
    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: MarketPlan
    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: MarketPlan
    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: MarketPlan
    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: MarketPlan
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:MarketPlan