Class: CongestionRevenueRight

name: CongestionRevenueRight
description: "Congestion Revenue Rights (CRR) class that is inherited from a Document\
  \ class.\r\n\r\nA CRR is a financial concept that is used to hedge congestion charges.\r\
  \n\r\nThe CRR is usually settled based on the Locational Marginal Prices (LMPs)\
  \ that are calculated in the day-ahead market. These LMPs are determined by the\
  \ Day-ahead resource schedules/bids. CRRs will not hedge against marginal losses.\
  \ If the congestion component of LMP at the sink is greater than at the source,\
  \ then the CRR owner is entitled to receive a portion of congestion revenues. If\
  \ the congestion component at the sink is less than at the source, then an obligation-type\
  \ CRR owner will be charged, but an option-type CRR owner will not."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
  c_rrcategory:
    name: c_rrcategory
    description: CRR category represents 'PTP' for a point-to-point CRR, or 'NSR'
      for a Network Service Right. If CRR category is 'PTP', both Source ID and Sink
      ID fields are required. If CRR category is 'NSR' only one field, either Source
      ID or Sink ID, shall be not null and the other shall be null. However, the 'NSR'
      category will include at least three records.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.cRRcategory
    multivalued: false
    domain_of:
    - CongestionRevenueRight
    range: CRRCategoryType
    required: false
  c_rrtype:
    name: c_rrtype
    description: Type of the CRR, from the possible type definitions in the CRR System
      (e.g. 'LSE', 'ETC').
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.cRRtype
    multivalued: false
    domain_of:
    - CongestionRevenueRight
    range: CRRSegmentType
    required: false
  hedge_type:
    name: hedge_type
    description: Hedge type Obligation or Option. An obligation type requires the
      holder to receive or pay the congestion rent. An option type gives the holder
      the option of receiving or paying the congestion rent.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.hedgeType
    multivalued: false
    domain_of:
    - CongestionRevenueRight
    range: CRRHedgeType
    required: false
  time_of_use:
    name: time_of_use
    description: Time of Use flag of the CRR - Peak (ON), Offpeak (OFF) or all 24
      hours (24HR).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.timeOfUse
    multivalued: false
    domain_of:
    - CongestionRevenueRight
    range: TimeOfUse
    required: false
  trade_slice_id:
    name: trade_slice_id
    description: "Segment of the CRR described in the current record.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.tradeSliceID
    multivalued: false
    domain_of:
    - CongestionRevenueRight
    range: string
    required: false
  crrsegment:
    name: crrsegment
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.CRRSegment
    multivalued: true
    domain_of:
    - CongestionRevenueRight
    range: CRRSegment
    required: true
  crrmarket:
    name: crrmarket
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.CRRMarket
    multivalued: false
    domain_of:
    - CongestionRevenueRight
    range: CRRMarket
    required: true
  flowgate:
    name: flowgate
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CongestionRevenueRight.Flowgate
    multivalued: false
    domain_of:
    - FTR
    - MktLine
    - ViolationLimit
    - HostControlArea
    - RegisteredInterTie
    - SchedulingPoint
    - SecurityConstraints
    - TransmissionInterfaceRightEntitlement
    - ContractDistributionFactor
    - ConstraintResults
    - GeneratingUnitDynamicValues
    - CongestionRevenueRight
    - GenericConstraints
    - TransmissionCapacity
    - MktTerminal
    - FlowgateValue
    - FlowgateRelief
    - MktPowerTransformer
    - InterTieResults
    range: Flowgate
    required: false
  crrorg_role:
    name: crrorg_role
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.CRROrgRole
    multivalued: true
    domain_of:
    - CongestionRevenueRight
    range: CRROrgRole
    required: true
class_uri: cim:CongestionRevenueRight

name: CongestionRevenueRight
description: "Congestion Revenue Rights (CRR) class that is inherited from a Document\
  \ class.\r\n\r\nA CRR is a financial concept that is used to hedge congestion charges.\r\
  \n\r\nThe CRR is usually settled based on the Locational Marginal Prices (LMPs)\
  \ that are calculated in the day-ahead market. These LMPs are determined by the\
  \ Day-ahead resource schedules/bids. CRRs will not hedge against marginal losses.\
  \ If the congestion component of LMP at the sink is greater than at the source,\
  \ then the CRR owner is entitled to receive a portion of congestion revenues. If\
  \ the congestion component at the sink is less than at the source, then an obligation-type\
  \ CRR owner will be charged, but an option-type CRR owner will not."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
  c_rrcategory:
    name: c_rrcategory
    description: CRR category represents 'PTP' for a point-to-point CRR, or 'NSR'
      for a Network Service Right. If CRR category is 'PTP', both Source ID and Sink
      ID fields are required. If CRR category is 'NSR' only one field, either Source
      ID or Sink ID, shall be not null and the other shall be null. However, the 'NSR'
      category will include at least three records.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.cRRcategory
    multivalued: false
    alias: c_rrcategory
    owner: CongestionRevenueRight
    domain_of:
    - CongestionRevenueRight
    range: CRRCategoryType
    required: false
  c_rrtype:
    name: c_rrtype
    description: Type of the CRR, from the possible type definitions in the CRR System
      (e.g. 'LSE', 'ETC').
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.cRRtype
    multivalued: false
    alias: c_rrtype
    owner: CongestionRevenueRight
    domain_of:
    - CongestionRevenueRight
    range: CRRSegmentType
    required: false
  hedge_type:
    name: hedge_type
    description: Hedge type Obligation or Option. An obligation type requires the
      holder to receive or pay the congestion rent. An option type gives the holder
      the option of receiving or paying the congestion rent.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.hedgeType
    multivalued: false
    alias: hedge_type
    owner: CongestionRevenueRight
    domain_of:
    - CongestionRevenueRight
    range: CRRHedgeType
    required: false
  time_of_use:
    name: time_of_use
    description: Time of Use flag of the CRR - Peak (ON), Offpeak (OFF) or all 24
      hours (24HR).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.timeOfUse
    multivalued: false
    alias: time_of_use
    owner: CongestionRevenueRight
    domain_of:
    - CongestionRevenueRight
    range: TimeOfUse
    required: false
  trade_slice_id:
    name: trade_slice_id
    description: "Segment of the CRR described in the current record.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.tradeSliceID
    multivalued: false
    alias: trade_slice_id
    owner: CongestionRevenueRight
    domain_of:
    - CongestionRevenueRight
    range: string
    required: false
  crrsegment:
    name: crrsegment
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.CRRSegment
    multivalued: true
    alias: crrsegment
    owner: CongestionRevenueRight
    domain_of:
    - CongestionRevenueRight
    range: CRRSegment
    required: true
  crrmarket:
    name: crrmarket
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.CRRMarket
    multivalued: false
    alias: crrmarket
    owner: CongestionRevenueRight
    domain_of:
    - CongestionRevenueRight
    range: CRRMarket
    required: true
  flowgate:
    name: flowgate
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:CongestionRevenueRight.Flowgate
    multivalued: false
    alias: flowgate
    owner: CongestionRevenueRight
    domain_of:
    - FTR
    - MktLine
    - ViolationLimit
    - HostControlArea
    - RegisteredInterTie
    - SchedulingPoint
    - SecurityConstraints
    - TransmissionInterfaceRightEntitlement
    - ContractDistributionFactor
    - ConstraintResults
    - GeneratingUnitDynamicValues
    - CongestionRevenueRight
    - GenericConstraints
    - TransmissionCapacity
    - MktTerminal
    - FlowgateValue
    - FlowgateRelief
    - MktPowerTransformer
    - InterTieResults
    range: Flowgate
    required: false
  crrorg_role:
    name: crrorg_role
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:CongestionRevenueRight.CRROrgRole
    multivalued: true
    alias: crrorg_role
    owner: CongestionRevenueRight
    domain_of:
    - CongestionRevenueRight
    range: CRROrgRole
    required: true
  author_name:
    name: author_name
    description: Name of the author of this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.authorName
    multivalued: false
    alias: author_name
    owner: CongestionRevenueRight
    domain_of:
    - Document
    range: string
    required: false
  comment:
    name: comment
    description: Free text comment.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Document.comment
    multivalued: false
    alias: comment
    owner: CongestionRevenueRight
    domain_of:
    - NetworkModelProjectChangeVersion
    - Document
    - SwitchingPlanRequest
    - SwitchingOrder
    - TroubleOrder
    - ReadingQuality
    - TroubleTicket
    - OutageOrder
    range: string
    required: false
  created_date_time:
    name: created_date_time
    description: "Date and time that this document was created.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.createdDateTime
    multivalued: false
    alias: created_date_time
    owner: CongestionRevenueRight
    domain_of:
    - Document
    - ActivityRecord
    range: date
    required: false
  doc_status:
    name: doc_status
    description: "Status of this document. For status of subject matter this document\
      \ represents (e.g., Agreement, Work), use 'status' attribute.\r\nExample values\
      \ for 'docStatus.status' are draft, approved, cancelled, etc."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.docStatus
    multivalued: false
    alias: doc_status
    owner: CongestionRevenueRight
    domain_of:
    - Document
    range: Status
    required: false
  electronic_address:
    name: electronic_address
    description: Electronic address.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Document.electronicAddress
    multivalued: false
    alias: electronic_address
    owner: CongestionRevenueRight
    domain_of:
    - Asset
    - Document
    - Person
    - Organisation
    - Location
    - Cashier
    range: ElectronicAddress
    required: false
  last_modified_date_time:
    name: last_modified_date_time
    description: "Date and time this document was last modified. Documents may potentially\
      \ be modified many times during their lifetime.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.lastModifiedDateTime
    multivalued: false
    alias: last_modified_date_time
    owner: CongestionRevenueRight
    domain_of:
    - Document
    range: date
    required: false
  revision_number:
    name: revision_number
    description: Revision number for this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.revisionNumber
    multivalued: false
    alias: revision_number
    owner: CongestionRevenueRight
    domain_of:
    - Document
    - MajorChargeGroup
    range: string
    required: false
  status:
    name: status
    description: Status of subject matter (e.g., Agreement, Work) this document represents.
      For status of the document itself, use 'docStatus' attribute.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Document.status
    multivalued: false
    alias: status
    owner: CongestionRevenueRight
    domain_of:
    - Asset
    - Document
    - Customer
    - StreetAddress
    - Location
    - ErpQuoteLineItem
    - CostType
    - ErpJournalEntry
    - ErpRecLineItem
    - ErpPayableLineItem
    - ContractorItem
    - Capability
    - Craft
    - OldPerson
    - ErpPersonnel
    - LaborItem
    - DesignLocationCU
    - DesignLocation
    - ConditionFactor
    - MiscCostItem
    - CUGroup
    - WorkFlowStep
    - ErpTimeEntry
    - OverheadCost
    - PropertyUnit
    - CUMaterialItem
    - ErpIssueInventory
    - ErpReqLineItem
    - ErpRecDelvLineItem
    - Role
    - LandProperty
    - ErpSiteLevelData
    - Crew
    - ActivityRecord
    - ErpLedgerEntry
    - ErpLedBudLineItem
    - TransformerObservation
    - BushingInsulationPF
    - WindingInsulation
    - CULaborItem
    - CULaborCode
    - EndDeviceGroup
    - Hazard
    - CUWorkEquipmentItem
    - ShiftPattern
    - Route
    - Usage
    - CUContractorItem
    - CUAllowableAction
    - TypeAssetCatalogue
    - AssetModelCatalogue
    - Market
    - CRROrgRole
    - MarketScheduledEvent
    - MarketLedgerEntry
    - MarketPerson
    - MarketQualificationRequirement
    - ResourceGroup
    - ResourceAwardInstruction
    - ExPostResourceResults
    - MarketObjectStatus
    - TimePoint
    - ErpItemMaster
    - ScheduledEvent
    - ScheduledEventData
    - ErpInventory
    - ErpInventoryCount
    - RedLine
    - BusinessRole
    - BidTimeSeries
    range: Status
    required: false
  subject:
    name: subject
    description: Document subject.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.subject
    multivalued: false
    alias: subject
    owner: CongestionRevenueRight
    domain_of:
    - Document
    range: string
    required: false
  title:
    name: title
    description: Document title.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.title
    multivalued: false
    alias: title
    owner: CongestionRevenueRight
    domain_of:
    - Document
    range: string
    required: false
  type:
    name: type
    description: Utility-specific classification of this document, according to its
      corporate standards, practices, and existing IT systems (e.g., for management
      of assets, maintenance, work, outage, customers, etc.).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Document.type
    multivalued: false
    alias: type
    owner: CongestionRevenueRight
    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
  activity_record:
    name: activity_record
    description: The activity record for a document
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.ActivityRecord
    multivalued: true
    alias: activity_record
    owner: CongestionRevenueRight
    domain_of:
    - Document
    range: ActivityRecord
    required: false
  configuration_events:
    name: configuration_events
    description: All configuration events created for this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Document.ConfigurationEvents
    multivalued: true
    alias: configuration_events
    owner: CongestionRevenueRight
    domain_of:
    - Asset
    - Document
    - PersonRole
    - OrganisationRole
    - Location
    - UsagePoint
    - ServiceCategory
    range: ConfigurationEvent
    required: false
  author:
    name: author
    description: Author of this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.Author
    multivalued: false
    alias: author
    owner: CongestionRevenueRight
    domain_of:
    - Document
    - ActivityRecord
    range: Author
    required: false
  editor:
    name: editor
    description: Editor of this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.Editor
    multivalued: false
    alias: editor
    owner: CongestionRevenueRight
    domain_of:
    - Document
    range: Editor
    required: false
  approver:
    name: approver
    description: Approver of this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.Approver
    multivalued: false
    alias: approver
    owner: CongestionRevenueRight
    domain_of:
    - Document
    range: Approver
    required: false
  issuer:
    name: issuer
    description: Issuer of this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.Issuer
    multivalued: false
    alias: issuer
    owner: CongestionRevenueRight
    domain_of:
    - Document
    range: Issuer
    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: CongestionRevenueRight
    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: CongestionRevenueRight
    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: CongestionRevenueRight
    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: CongestionRevenueRight
    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: CongestionRevenueRight
    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: CongestionRevenueRight
    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: CongestionRevenueRight
    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: CongestionRevenueRight
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:CongestionRevenueRight