Skip to content

Class: MarketRole

The external intended behavior played by a party within the electricity market.

URI: cim:MarketRole

 classDiagram
    class MarketRole
      OrganisationRole <|-- MarketRole

      MarketRole : alias_name

      MarketRole : configuration_events

          MarketRole --> ConfigurationEvent : configuration_events

      MarketRole : description

      MarketRole : diagram_objects

          MarketRole --> DiagramObject : diagram_objects

      MarketRole : instance_set

          MarketRole --> InstanceSet : instance_set

      MarketRole : m_rid

      MarketRole : market_participant

          MarketRole --> MarketParticipant : market_participant

      MarketRole : names

          MarketRole --> Name : names

      MarketRole : organisation

          MarketRole --> Organisation : organisation

      MarketRole : properties_cimdata_object

          MarketRole --> ChangeSetMember : properties_cimdata_object

      MarketRole : targeting_cimdata_object

          MarketRole --> ChangeSetMember : targeting_cimdata_object

      MarketRole : type

Inheritance

Slots

Name Cardinality and Range Description Inheritance
type 0..1
String		 The kind of market roles that can be played by parties for given domains with... direct
market_participant 0..*
MarketParticipant		 direct
organisation 0..1
Organisation		 Organisation having this role OrganisationRole
configuration_events 0..*
ConfigurationEvent		 All configuration events created for this organisation role OrganisationRole
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
RTO market_role range MarketRole
MarketParticipant market_role range MarketRole
SchedulingCoordinator market_role range MarketRole

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: MarketRole
description: The external intended behavior played by a party within the electricity
  market.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: OrganisationRole
attributes:
  type:
    name: type
    description: "The kind of market roles that can be played by parties for given\
      \ domains within the electricity market. Types are flexible using dataType of\
      \ string for free-entry of role types.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketRole.type
    multivalued: false
    domain_of:
    - Asset
    - AcceptanceTest
    - Document
    - StreetDetail
    - Location
    - Priority
    - CatalogAssetType
    - Capability
    - Craft
    - OldPerson
    - Role
    - ActivityRecord
    - EndDeviceEventType
    - EndDeviceGroup
    - DemandResponseProgram
    - UsagePointGroup
    - EndDeviceControlType
    - Hazard
    - OldCrew
    - Route
    - ConstraintDuration
    - AceTariffType
    - ControlArea
    - SynchronousMachine
    - ChargeProfile
    - ChargeComponent
    - MarketRole
    - ResourceGroup
    - Quantity
    - ResourceCertification
    - Auction
    - ScheduledEvent
    - PotentialTransformer
    - BusinessRole
    range: string
    required: false
  market_participant:
    name: market_participant
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketRole.MarketParticipant
    multivalued: true
    domain_of:
    - TimeSeries
    - MarketDocument
    - RegisteredResource
    - Bid
    - SchedulingCoordinator
    - MarketRole
    - MarketPerson
    range: MarketParticipant
    required: false
class_uri: cim:MarketRole

Induced

name: MarketRole
description: The external intended behavior played by a party within the electricity
  market.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: OrganisationRole
attributes:
  type:
    name: type
    description: "The kind of market roles that can be played by parties for given\
      \ domains within the electricity market. Types are flexible using dataType of\
      \ string for free-entry of role types.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketRole.type
    multivalued: false
    alias: type
    owner: MarketRole
    domain_of:
    - Asset
    - AcceptanceTest
    - Document
    - StreetDetail
    - Location
    - Priority
    - CatalogAssetType
    - Capability
    - Craft
    - OldPerson
    - Role
    - ActivityRecord
    - EndDeviceEventType
    - EndDeviceGroup
    - DemandResponseProgram
    - UsagePointGroup
    - EndDeviceControlType
    - Hazard
    - OldCrew
    - Route
    - ConstraintDuration
    - AceTariffType
    - ControlArea
    - SynchronousMachine
    - ChargeProfile
    - ChargeComponent
    - MarketRole
    - ResourceGroup
    - Quantity
    - ResourceCertification
    - Auction
    - ScheduledEvent
    - PotentialTransformer
    - BusinessRole
    range: string
    required: false
  market_participant:
    name: market_participant
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketRole.MarketParticipant
    multivalued: true
    alias: market_participant
    owner: MarketRole
    domain_of:
    - TimeSeries
    - MarketDocument
    - RegisteredResource
    - Bid
    - SchedulingCoordinator
    - MarketRole
    - MarketPerson
    range: MarketParticipant
    required: false
  organisation:
    name: organisation
    description: Organisation having this role.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:OrganisationRole.Organisation
    multivalued: false
    alias: organisation
    owner: MarketRole
    domain_of:
    - OrganisationRole
    - ParentOrganization
    range: Organisation
    required: false
  configuration_events:
    name: configuration_events
    description: All configuration events created for this organisation role.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:OrganisationRole.ConfigurationEvents
    multivalued: true
    alias: configuration_events
    owner: MarketRole
    domain_of:
    - Asset
    - Document
    - PersonRole
    - OrganisationRole
    - Location
    - UsagePoint
    - ServiceCategory
    range: ConfigurationEvent
    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: MarketRole
    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: MarketRole
    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: MarketRole
    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: MarketRole
    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: MarketRole
    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: MarketRole
    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: MarketRole
    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: MarketRole
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:MarketRole