Skip to content

Class: ResourceAwardClearing

_Models details of bid and offer market clearing. Class indicates whether a contingency is active and whether the automatic dispatching system is active for this interval of the market solution. _

__

URI: cim:ResourceAwardClearing

 classDiagram
    class ResourceAwardClearing
      MarketFactors <|-- ResourceAwardClearing

      ResourceAwardClearing : activity_record

          ResourceAwardClearing --> ActivityRecord : activity_record

      ResourceAwardClearing : alias_name

      ResourceAwardClearing : approver

          ResourceAwardClearing --> Approver : approver

      ResourceAwardClearing : author

          ResourceAwardClearing --> Author : author

      ResourceAwardClearing : author_name

      ResourceAwardClearing : comment

      ResourceAwardClearing : configuration_events

          ResourceAwardClearing --> ConfigurationEvent : configuration_events

      ResourceAwardClearing : contingency_active

          ResourceAwardClearing --> YesNo : contingency_active

      ResourceAwardClearing : created_date_time

      ResourceAwardClearing : description

      ResourceAwardClearing : diagram_objects

          ResourceAwardClearing --> DiagramObject : diagram_objects

      ResourceAwardClearing : dispatch_mode

          ResourceAwardClearing --> AutomaticDispatchMode : dispatch_mode

      ResourceAwardClearing : doc_status

          ResourceAwardClearing --> Status : doc_status

      ResourceAwardClearing : editor

          ResourceAwardClearing --> Editor : editor

      ResourceAwardClearing : electronic_address

          ResourceAwardClearing --> ElectronicAddress : electronic_address

      ResourceAwardClearing : instance_set

          ResourceAwardClearing --> InstanceSet : instance_set

      ResourceAwardClearing : interval_end_time

      ResourceAwardClearing : interval_start_time

      ResourceAwardClearing : issuer

          ResourceAwardClearing --> Issuer : issuer

      ResourceAwardClearing : last_modified_date_time

      ResourceAwardClearing : m_rid

      ResourceAwardClearing : market

          ResourceAwardClearing --> Market : market

      ResourceAwardClearing : mkt_activity_record

          ResourceAwardClearing --> MktActivityRecord : mkt_activity_record

      ResourceAwardClearing : names

          ResourceAwardClearing --> Name : names

      ResourceAwardClearing : properties_cimdata_object

          ResourceAwardClearing --> ChangeSetMember : properties_cimdata_object

      ResourceAwardClearing : resource_award_instruction

          ResourceAwardClearing --> ResourceAwardInstruction : resource_award_instruction

      ResourceAwardClearing : revision_number

      ResourceAwardClearing : rucaward_instruction

          ResourceAwardClearing --> RUCAwardInstruction : rucaward_instruction

      ResourceAwardClearing : status

          ResourceAwardClearing --> Status : status

      ResourceAwardClearing : subject

      ResourceAwardClearing : targeting_cimdata_object

          ResourceAwardClearing --> ChangeSetMember : targeting_cimdata_object

      ResourceAwardClearing : title

      ResourceAwardClearing : type

Inheritance

Slots

Name Cardinality and Range Description Inheritance
contingency_active 0..1
YesNo
Indication that the system is currently operating in a contingency mode direct
dispatch_mode 0..1
AutomaticDispatchMode
direct
rucaward_instruction 1..*
RUCAwardInstruction
direct
resource_award_instruction 1..*
ResourceAwardInstruction
direct
interval_end_time 0..1
date
The end of the time interval for which requirement is defined MarketFactors
interval_start_time 0..1
date
The start of the time interval for which requirement is defined MarketFactors
mkt_activity_record 0..*
MktActivityRecord
MarketFactors
market 0..1
Market
MarketFactors
author_name 0..1
String
Name of the author of this document Document
comment 0..1
String
Free text comment Document
created_date_time 0..1
date
Date and time that this document was created Document
doc_status 0..1
Status
Status of this document Document
electronic_address 0..1
ElectronicAddress
Electronic address Document
last_modified_date_time 0..1
date
Date and time this document was last modified Document
revision_number 0..1
String
Revision number for this document Document
status 0..1
Status
Status of subject matter (e Document
subject 0..1
String
Document subject Document
title 0..1
String
Document title Document
type 0..1
String
Utility-specific classification of this document, according to its corporate ... Document
activity_record 0..*
ActivityRecord
The activity record for a document Document
configuration_events 0..*
ConfigurationEvent
All configuration events created for this document Document
author 0..1
Author
Author of this document Document
editor 0..1
Editor
Editor of this document Document
approver 0..1
Approver
Approver of this document Document
issuer 0..1
Issuer
Issuer of this document Document
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
ResourceAwardInstruction clearing_resource_award range ResourceAwardClearing
RUCAwardInstruction clearing_resource_award range ResourceAwardClearing

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: ResourceAwardClearing
description: "Models details of bid and offer market clearing. Class indicates whether\
  \ a contingency is active and whether the automatic dispatching system is active\
  \ for this interval of the market solution.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: MarketFactors
attributes:
  contingency_active:
    name: contingency_active
    description: Indication that the system is currently operating in a contingency
      mode.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResourceAwardClearing.contingencyActive
    multivalued: false
    domain_of:
    - InstructionClearingDOT
    - ResourceAwardClearing
    range: YesNo
    required: false
  dispatch_mode:
    name: dispatch_mode
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResourceAwardClearing.dispatchMode
    multivalued: false
    domain_of:
    - InstructionClearingDOT
    - ResourceAwardClearing
    range: AutomaticDispatchMode
    required: false
  rucaward_instruction:
    name: rucaward_instruction
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResourceAwardClearing.RUCAwardInstruction
    multivalued: true
    domain_of:
    - RegisteredResource
    - ResourceAwardClearing
    range: RUCAwardInstruction
    required: true
  resource_award_instruction:
    name: resource_award_instruction
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResourceAwardClearing.ResourceAwardInstruction
    multivalued: true
    domain_of:
    - RegisteredResource
    - MarketProduct
    - ResourceAwardClearing
    - SelfScheduleBreakdown
    range: ResourceAwardInstruction
    required: true
class_uri: cim:ResourceAwardClearing

Induced

name: ResourceAwardClearing
description: "Models details of bid and offer market clearing. Class indicates whether\
  \ a contingency is active and whether the automatic dispatching system is active\
  \ for this interval of the market solution.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: MarketFactors
attributes:
  contingency_active:
    name: contingency_active
    description: Indication that the system is currently operating in a contingency
      mode.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResourceAwardClearing.contingencyActive
    multivalued: false
    alias: contingency_active
    owner: ResourceAwardClearing
    domain_of:
    - InstructionClearingDOT
    - ResourceAwardClearing
    range: YesNo
    required: false
  dispatch_mode:
    name: dispatch_mode
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResourceAwardClearing.dispatchMode
    multivalued: false
    alias: dispatch_mode
    owner: ResourceAwardClearing
    domain_of:
    - InstructionClearingDOT
    - ResourceAwardClearing
    range: AutomaticDispatchMode
    required: false
  rucaward_instruction:
    name: rucaward_instruction
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResourceAwardClearing.RUCAwardInstruction
    multivalued: true
    alias: rucaward_instruction
    owner: ResourceAwardClearing
    domain_of:
    - RegisteredResource
    - ResourceAwardClearing
    range: RUCAwardInstruction
    required: true
  resource_award_instruction:
    name: resource_award_instruction
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResourceAwardClearing.ResourceAwardInstruction
    multivalued: true
    alias: resource_award_instruction
    owner: ResourceAwardClearing
    domain_of:
    - RegisteredResource
    - MarketProduct
    - ResourceAwardClearing
    - SelfScheduleBreakdown
    range: ResourceAwardInstruction
    required: true
  interval_end_time:
    name: interval_end_time
    description: "The end of the time interval for which requirement is defined.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketFactors.intervalEndTime
    multivalued: false
    alias: interval_end_time
    owner: ResourceAwardClearing
    domain_of:
    - MarketFactors
    - DistributionFactorSet
    - LoadRatio
    - GenericConstraints
    - Commitments
    range: date
    required: false
  interval_start_time:
    name: interval_start_time
    description: "The start of the time interval for which requirement is defined.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketFactors.intervalStartTime
    multivalued: false
    alias: interval_start_time
    owner: ResourceAwardClearing
    domain_of:
    - MarketFactors
    - DistributionFactorSet
    - LoadRatio
    - GenericConstraints
    - TradingHubPrice
    - MitigatedBidSegment
    - ASRequirements
    - ExpectedEnergy
    - ResourceLoadFollowingInst
    - AllocationResult
    - Commitments
    - AuxiliaryCost
    - FiveMinAuxiliaryData
    - TenMinAuxiliaryData
    range: date
    required: false
  mkt_activity_record:
    name: mkt_activity_record
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketFactors.MktActivityRecord
    multivalued: true
    alias: mkt_activity_record
    owner: ResourceAwardClearing
    domain_of:
    - MarketFactors
    range: MktActivityRecord
    required: false
  market:
    name: market
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketFactors.Market
    multivalued: false
    alias: market
    owner: ResourceAwardClearing
    domain_of:
    - MarketFactors
    - MarketRun
    - MarketProduct
    - ResourceCertification
    range: Market
    required: false
  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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    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: ResourceAwardClearing
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:ResourceAwardClearing