Skip to content

Class: CRRSegment

_CRRSegment represents a segment of a CRR in a particular time frame. _

_ _

The segment class contains amount, clearing price, start date and time, end date and time.

URI: cim:CRRSegment

 classDiagram
    class CRRSegment
      IdentifiedObject <|-- CRRSegment

      CRRSegment : alias_name

      CRRSegment : amount

          CRRSegment --> Money : amount

      CRRSegment : clearing_price

          CRRSegment --> Money : clearing_price

      CRRSegment : congestion_revenue_right

          CRRSegment --> CongestionRevenueRight : congestion_revenue_right

      CRRSegment : description

      CRRSegment : diagram_objects

          CRRSegment --> DiagramObject : diagram_objects

      CRRSegment : end_date_time

      CRRSegment : instance_set

          CRRSegment --> InstanceSet : instance_set

      CRRSegment : m_rid

      CRRSegment : names

          CRRSegment --> Name : names

      CRRSegment : properties_cimdata_object

          CRRSegment --> ChangeSetMember : properties_cimdata_object

      CRRSegment : quantity

      CRRSegment : sink

          CRRSegment --> Pnode : sink

      CRRSegment : source

          CRRSegment --> Pnode : source

      CRRSegment : start_date_time

      CRRSegment : targeting_cimdata_object

          CRRSegment --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
amount 0..1
Money		 Dollar amount = quantity x clearingPrice
direct
clearing_price 0..1
Money		 Clearing price of a CRR
direct
end_date_time 0..1
date		 segment end date time
direct
quantity 0..1
Float		 The MW amount associated with the CRR
direct
start_date_time 0..1
date		 segment start date time
direct
congestion_revenue_right 1..1
CongestionRevenueRight		 direct
sink 0..*
Pnode		 direct
source 0..*
Pnode		 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
AggregatedPnode sink_crrsegment range CRRSegment
AggregatedPnode source_crrsegment range CRRSegment
Pnode sink_crrsegment range CRRSegment
Pnode source_crrsegment range CRRSegment
IndividualPnode sink_crrsegment range CRRSegment
IndividualPnode source_crrsegment range CRRSegment
CongestionArea sink_crrsegment range CRRSegment
CongestionArea source_crrsegment range CRRSegment
CongestionRevenueRight crrsegment range CRRSegment

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: CRRSegment
description: "CRRSegment represents a segment of a CRR in a particular time frame.\
  \ \r\n\r\nThe segment class contains amount, clearing price, start date and time,\
  \ end date and time."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  amount:
    name: amount
    description: "Dollar amount = quantity x clearingPrice\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.amount
    multivalued: false
    domain_of:
    - ErpJournalEntry
    - WorkCostDetail
    - LineDetail
    - ErpLedgerEntry
    - Tender
    - AccountMovement
    - ErpInvoice
    - CRRSegment
    - MarketInvoice
    - PassThroughBill
    - MarketLedgerEntry
    - Price
    - NonStandardItem
    range: Money
    required: false
  clearing_price:
    name: clearing_price
    description: "Clearing price of a CRR\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CRRSegment.clearingPrice
    multivalued: false
    domain_of:
    - CRRSegment
    range: Money
    required: false
  end_date_time:
    name: end_date_time
    description: "segment end date time\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CRRSegment.endDateTime
    multivalued: false
    domain_of:
    - CRRSegment
    range: date
    required: false
  quantity:
    name: quantity
    description: "The MW amount associated with the CRR\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.quantity
    multivalued: false
    domain_of:
    - FinancialInfo
    - CatalogAssetType
    - CompatibleUnit
    - MiscCostItem
    - CUMaterialItem
    - TypeMaterial
    - MaterialItem
    - ErpReqLineItem
    - TimeSeries
    - Point
    - CRRSegment
    - PassThroughBill
    - Domain
    - Quantity
    range: float
    required: false
  start_date_time:
    name: start_date_time
    description: "segment start date time\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.startDateTime
    multivalued: false
    domain_of:
    - EndDeviceAction
    - CRRSegment
    - ProfileData
    range: date
    required: false
  congestion_revenue_right:
    name: congestion_revenue_right
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.CongestionRevenueRight
    multivalued: false
    domain_of:
    - Flowgate
    - CRROrgRole
    - CRRSegment
    - CRRMarket
    range: CongestionRevenueRight
    required: true
  sink:
    name: sink
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.Sink
    multivalued: true
    domain_of:
    - TransmissionReservation
    - CRRSegment
    range: Pnode
    required: false
  source:
    name: source
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.Source
    multivalued: true
    domain_of:
    - Quality61850
    - BaseReading
    - ReadingQuality
    - TransmissionReservation
    - CRRSegment
    - BillDeterminant
    range: Pnode
    required: false
class_uri: cim:CRRSegment

Induced

name: CRRSegment
description: "CRRSegment represents a segment of a CRR in a particular time frame.\
  \ \r\n\r\nThe segment class contains amount, clearing price, start date and time,\
  \ end date and time."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  amount:
    name: amount
    description: "Dollar amount = quantity x clearingPrice\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.amount
    multivalued: false
    alias: amount
    owner: CRRSegment
    domain_of:
    - ErpJournalEntry
    - WorkCostDetail
    - LineDetail
    - ErpLedgerEntry
    - Tender
    - AccountMovement
    - ErpInvoice
    - CRRSegment
    - MarketInvoice
    - PassThroughBill
    - MarketLedgerEntry
    - Price
    - NonStandardItem
    range: Money
    required: false
  clearing_price:
    name: clearing_price
    description: "Clearing price of a CRR\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CRRSegment.clearingPrice
    multivalued: false
    alias: clearing_price
    owner: CRRSegment
    domain_of:
    - CRRSegment
    range: Money
    required: false
  end_date_time:
    name: end_date_time
    description: "segment end date time\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CRRSegment.endDateTime
    multivalued: false
    alias: end_date_time
    owner: CRRSegment
    domain_of:
    - CRRSegment
    range: date
    required: false
  quantity:
    name: quantity
    description: "The MW amount associated with the CRR\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.quantity
    multivalued: false
    alias: quantity
    owner: CRRSegment
    domain_of:
    - FinancialInfo
    - CatalogAssetType
    - CompatibleUnit
    - MiscCostItem
    - CUMaterialItem
    - TypeMaterial
    - MaterialItem
    - ErpReqLineItem
    - TimeSeries
    - Point
    - CRRSegment
    - PassThroughBill
    - Domain
    - Quantity
    range: float
    required: false
  start_date_time:
    name: start_date_time
    description: "segment start date time\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.startDateTime
    multivalued: false
    alias: start_date_time
    owner: CRRSegment
    domain_of:
    - EndDeviceAction
    - CRRSegment
    - ProfileData
    range: date
    required: false
  congestion_revenue_right:
    name: congestion_revenue_right
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.CongestionRevenueRight
    multivalued: false
    alias: congestion_revenue_right
    owner: CRRSegment
    domain_of:
    - Flowgate
    - CRROrgRole
    - CRRSegment
    - CRRMarket
    range: CongestionRevenueRight
    required: true
  sink:
    name: sink
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.Sink
    multivalued: true
    alias: sink
    owner: CRRSegment
    domain_of:
    - TransmissionReservation
    - CRRSegment
    range: Pnode
    required: false
  source:
    name: source
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CRRSegment.Source
    multivalued: true
    alias: source
    owner: CRRSegment
    domain_of:
    - Quality61850
    - BaseReading
    - ReadingQuality
    - TransmissionReservation
    - CRRSegment
    - BillDeterminant
    range: Pnode
    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: CRRSegment
    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: CRRSegment
    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: CRRSegment
    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: CRRSegment
    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: CRRSegment
    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: CRRSegment
    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: CRRSegment
    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: CRRSegment
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:CRRSegment