Skip to content

Class: AllocationResultValues

_Models Market clearing results in terms of price and MW values. _

__

URI: cim:AllocationResultValues

 classDiagram
    class AllocationResultValues
      AllocationResultValues : aggregate_type

      AllocationResultValues : allocation_mw_hour

      AllocationResultValues : allocation_price

      AllocationResultValues : allocation_result

          AllocationResultValues --> AllocationResult : allocation_result

      AllocationResultValues : energy_type_code

      AllocationResultValues : market_service_type

      AllocationResultValues : registered_resource

          AllocationResultValues --> RegisteredResource : registered_resource

Slots

Name Cardinality and Range Description Inheritance
aggregate_type 0..1
String
"1" -- "Detail",
direct
allocation_mw_hour 0..1
Float
direct
allocation_price 0..1
Float
direct
energy_type_code 0..1
String
direct
market_service_type 0..1
String
Choices are:
direct
registered_resource 0..1
RegisteredResource
direct
allocation_result 1..1
AllocationResult
direct

Usages

used by used in type used
RegisteredResource allocation_result_values range AllocationResultValues
RegisteredGenerator allocation_result_values range AllocationResultValues
RegisteredInterTie allocation_result_values range AllocationResultValues
RegisteredLoad allocation_result_values range AllocationResultValues
CombinedCycleConfiguration allocation_result_values range AllocationResultValues
AllocationResult allocation_result_values range AllocationResultValues
RegisteredDistributedResource allocation_result_values range AllocationResultValues

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: AllocationResultValues
description: "Models Market clearing results in terms of price and MW values.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
attributes:
  aggregate_type:
    name: aggregate_type
    description: "\"1\" --  \"Detail\",\r\n\"2\" --  \"Aggregate by Market service\
      \ type\", in which case, the \"AllocationEnergyType\" field will not be filled;\r\
      \n\"3\" --  \"Aggregate by \"AllocationEnergyType\", in which case \"MarketServiceType\"\
      \ will not be filled.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AllocationResultValues.aggregateType
    multivalued: false
    domain_of:
    - AllocationResultValues
    range: string
    required: false
  allocation_mw_hour:
    name: allocation_mw_hour
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AllocationResultValues.allocationMwHour
    multivalued: false
    domain_of:
    - AllocationResultValues
    range: float
    required: false
  allocation_price:
    name: allocation_price
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AllocationResultValues.allocationPrice
    multivalued: false
    domain_of:
    - AllocationResultValues
    range: float
    required: false
  energy_type_code:
    name: energy_type_code
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AllocationResultValues.energyTypeCode
    multivalued: false
    domain_of:
    - ExpectedEnergyValues
    - AllocationResultValues
    range: string
    required: false
  market_service_type:
    name: market_service_type
    description: "Choices are: \r\nME - Market Energy Capacity; \r\nSR - Spinning\
      \ Reserve Capacity; \r\nNR - Non-Spinning Reserve Capacity; \r\nDAC - Day Ahead\
      \ Capacity; \r\nDEC - Derate Capacity\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AllocationResultValues.marketServiceType
    multivalued: false
    domain_of:
    - AllocationResultValues
    range: string
    required: false
  registered_resource:
    name: registered_resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AllocationResultValues.RegisteredResource
    multivalued: false
    domain_of:
    - TimeSeries
    - Reason
    - DotInstruction
    - MarketParticipant
    - MPMResourceStatus
    - MPMTestThreshold
    - SubControlArea
    - AdjacentCASet
    - HostControlArea
    - RampRateCurve
    - SchedulingPoint
    - ResourceVerifiableCosts
    - ContractDistributionFactor
    - SubstitutionResourceList
    - MktConnectivityNode
    - AggregateNode
    - Instructions
    - ControlAreaDesignation
    - ResourceAwardInstruction
    - RUCAwardInstruction
    - Domain
    - ExPostResourceResults
    - LoadFollowingOperatorInput
    - MarketObjectStatus
    - DefaultBid
    - ResourceCertification
    - FormerReference
    - IntermittentResourceEligibility
    - ResourceCapacity
    - ExpectedEnergyValues
    - ResourceLoadFollowingInst
    - ResourceDispatchResults
    - LoadFollowingInst
    - AllocationResultValues
    - Commitments
    - RMROperatorInput
    - OrgResOwnership
    - DispatchInstReply
    - ForbiddenRegion
    - ResourcePerformanceRating
    - ResponseMethod
    range: RegisteredResource
    required: false
  allocation_result:
    name: allocation_result
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AllocationResultValues.AllocationResult
    multivalued: false
    domain_of:
    - AllocationResultValues
    range: AllocationResult
    required: true
class_uri: cim:AllocationResultValues

Induced

name: AllocationResultValues
description: "Models Market clearing results in terms of price and MW values.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
attributes:
  aggregate_type:
    name: aggregate_type
    description: "\"1\" --  \"Detail\",\r\n\"2\" --  \"Aggregate by Market service\
      \ type\", in which case, the \"AllocationEnergyType\" field will not be filled;\r\
      \n\"3\" --  \"Aggregate by \"AllocationEnergyType\", in which case \"MarketServiceType\"\
      \ will not be filled.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AllocationResultValues.aggregateType
    multivalued: false
    alias: aggregate_type
    owner: AllocationResultValues
    domain_of:
    - AllocationResultValues
    range: string
    required: false
  allocation_mw_hour:
    name: allocation_mw_hour
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AllocationResultValues.allocationMwHour
    multivalued: false
    alias: allocation_mw_hour
    owner: AllocationResultValues
    domain_of:
    - AllocationResultValues
    range: float
    required: false
  allocation_price:
    name: allocation_price
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AllocationResultValues.allocationPrice
    multivalued: false
    alias: allocation_price
    owner: AllocationResultValues
    domain_of:
    - AllocationResultValues
    range: float
    required: false
  energy_type_code:
    name: energy_type_code
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AllocationResultValues.energyTypeCode
    multivalued: false
    alias: energy_type_code
    owner: AllocationResultValues
    domain_of:
    - ExpectedEnergyValues
    - AllocationResultValues
    range: string
    required: false
  market_service_type:
    name: market_service_type
    description: "Choices are: \r\nME - Market Energy Capacity; \r\nSR - Spinning\
      \ Reserve Capacity; \r\nNR - Non-Spinning Reserve Capacity; \r\nDAC - Day Ahead\
      \ Capacity; \r\nDEC - Derate Capacity\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AllocationResultValues.marketServiceType
    multivalued: false
    alias: market_service_type
    owner: AllocationResultValues
    domain_of:
    - AllocationResultValues
    range: string
    required: false
  registered_resource:
    name: registered_resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AllocationResultValues.RegisteredResource
    multivalued: false
    alias: registered_resource
    owner: AllocationResultValues
    domain_of:
    - TimeSeries
    - Reason
    - DotInstruction
    - MarketParticipant
    - MPMResourceStatus
    - MPMTestThreshold
    - SubControlArea
    - AdjacentCASet
    - HostControlArea
    - RampRateCurve
    - SchedulingPoint
    - ResourceVerifiableCosts
    - ContractDistributionFactor
    - SubstitutionResourceList
    - MktConnectivityNode
    - AggregateNode
    - Instructions
    - ControlAreaDesignation
    - ResourceAwardInstruction
    - RUCAwardInstruction
    - Domain
    - ExPostResourceResults
    - LoadFollowingOperatorInput
    - MarketObjectStatus
    - DefaultBid
    - ResourceCertification
    - FormerReference
    - IntermittentResourceEligibility
    - ResourceCapacity
    - ExpectedEnergyValues
    - ResourceLoadFollowingInst
    - ResourceDispatchResults
    - LoadFollowingInst
    - AllocationResultValues
    - Commitments
    - RMROperatorInput
    - OrgResOwnership
    - DispatchInstReply
    - ForbiddenRegion
    - ResourcePerformanceRating
    - ResponseMethod
    range: RegisteredResource
    required: false
  allocation_result:
    name: allocation_result
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AllocationResultValues.AllocationResult
    multivalued: false
    alias: allocation_result
    owner: AllocationResultValues
    domain_of:
    - AllocationResultValues
    range: AllocationResult
    required: true
class_uri: cim:AllocationResultValues