Class: ConstraintResults
_Provides the Market results for the constraint processing for either the DAM or RTM. The data includes the constraint type (binding or violated), the solved value for the constraint, and the associated shadow price. _
__
classDiagram
class ConstraintResults
IdentifiedObject <|-- ConstraintResults
ConstraintResults : alias_name
ConstraintResults : base_flow
ConstraintResults : bglimit
ConstraintResults : bgtrres_cap
ConstraintResults : binding_limit
ConstraintResults : cleared_value
ConstraintResults : competitive_path_constraint
ConstraintResults --> YesNo : competitive_path_constraint
ConstraintResults : constraint_clearing
ConstraintResults --> ConstraintClearing : constraint_clearing
ConstraintResults : constraint_type
ConstraintResults --> ResultsConstraintType : constraint_type
ConstraintResults : description
ConstraintResults : diagram_objects
ConstraintResults --> DiagramObject : diagram_objects
ConstraintResults : flowgate
ConstraintResults --> Flowgate : flowgate
ConstraintResults : instance_set
ConstraintResults --> InstanceSet : instance_set
ConstraintResults : limit_flag
ConstraintResults --> ConstraintLimitType : limit_flag
ConstraintResults : m_rid
ConstraintResults : mkt_contingency
ConstraintResults --> MktContingency : mkt_contingency
ConstraintResults : names
ConstraintResults --> Name : names
ConstraintResults : optimization_flag
ConstraintResults --> YesNo : optimization_flag
ConstraintResults : overload_mw
ConstraintResults : percent_mw
ConstraintResults : properties_cimdata_object
ConstraintResults --> ChangeSetMember : properties_cimdata_object
ConstraintResults : shadow_price
ConstraintResults : targeting_cimdata_object
ConstraintResults --> ChangeSetMember : targeting_cimdata_object
ConstraintResults : update_time_stamp
ConstraintResults : update_type
ConstraintResults --> MQSCHGType : update_type
ConstraintResults : update_user
Inheritance
- IdentifiedObject
- ConstraintResults
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| base_flow | 0..1 Float |
Branch base Power Flow | direct |
| bglimit | 0..1 Float |
This value is determined in DA and RTM | direct |
| bgtrres_cap | 0..1 Float |
Branch Group TR Reservation Capacity - This value is determined in DA and RTM | direct |
| binding_limit | 0..1 Float |
MW Limit | direct |
| cleared_value | 0..1 Float |
Cleared MW | direct |
| competitive_path_constraint | 0..1 YesNo |
Non-competitive path constraint Flag"(Y/N) indicating whether the shadow pri... | direct |
| constraint_type | 0..1 ResultsConstraintType |
Type of constraint | direct |
| limit_flag | 0..1 ConstraintLimitType |
Limit flag ('Maximum', 'Minimum') | direct |
| optimization_flag | 0..1 YesNo |
Included in optimization Y/N | direct |
| overload_mw | 0..1 Float |
Transmission overload MW | direct |
| percent_mw | 0..1 Float |
Actual MW flow as percent of limit | direct |
| shadow_price | 0..1 Float |
Shadow Price ($/MW) for the commodity | direct |
| update_time_stamp | 0..1 date |
Update time stamp | direct |
| update_type | 0..1 MQSCHGType |
MQS change type | direct |
| update_user | 0..1 String |
Updated user | direct |
| mkt_contingency | 1..1 MktContingency |
direct | |
| flowgate | 1..1 Flowgate |
direct | |
| constraint_clearing | 0..1 ConstraintClearing |
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 |
|---|---|---|---|
| Flowgate | constraint_results | range | ConstraintResults |
| MktContingency | constraint_results | range | ConstraintResults |
| ConstraintClearing | constraint_results | range | ConstraintResults |
Identifier and Mapping Information
Schema Source
- from schema: https://cim.ucaiug.io/ns#TC57CIM
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | cim:ConstraintResults |
| native | cim:ConstraintResults |
LinkML Source
Direct
name: ConstraintResults
description: "Provides the Market results for the constraint processing for either\
\ the DAM or RTM. The data includes the constraint type (binding or violated), the\
\ solved value for the constraint, and the associated shadow price.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
base_flow:
name: base_flow
description: "Branch base Power Flow.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.baseFlow
multivalued: false
domain_of:
- ConstraintResults
range: float
required: false
bglimit:
name: bglimit
description: "This value is determined in DA and RTM. The SCUC optimization ensures\
\ that the MW flow on the Branch Group will not exceed this limit in the relevant\
\ direction. \r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.BGLimit
multivalued: false
domain_of:
- ConstraintResults
range: float
required: false
bgtrres_cap:
name: bgtrres_cap
description: "Branch Group TR Reservation Capacity - This value is determined\
\ in DA and RTM. It is the amount of spare transmission capacity that is left\
\ for the TR holder to use. \r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.BGTRResCap
multivalued: false
domain_of:
- ConstraintResults
range: float
required: false
binding_limit:
name: binding_limit
description: "MW Limit.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.bindingLimit
multivalued: false
domain_of:
- ConstraintResults
range: float
required: false
cleared_value:
name: cleared_value
description: "Cleared MW.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.clearedValue
multivalued: false
domain_of:
- ConstraintResults
- InterTieResults
range: float
required: false
competitive_path_constraint:
name: competitive_path_constraint
description: "Non-competitive path constraint Flag\"(Y/N) indicating whether\
\ the shadow price on a non-competitive path was non-zero.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.competitivePathConstraint
multivalued: false
domain_of:
- ConstraintResults
range: YesNo
required: false
constraint_type:
name: constraint_type
description: "Type of constraint.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.constraintType
multivalued: false
domain_of:
- ConstraintResults
range: ResultsConstraintType
required: false
limit_flag:
name: limit_flag
description: "Limit flag ('Maximum', 'Minimum').\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.limitFlag
multivalued: false
domain_of:
- ConstraintResults
- MarketRegionResults
range: ConstraintLimitType
required: false
optimization_flag:
name: optimization_flag
description: "Included in optimization Y/N.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.optimizationFlag
multivalued: false
domain_of:
- ConstraintResults
range: YesNo
required: false
overload_mw:
name: overload_mw
description: "Transmission overload MW.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.overloadMW
multivalued: false
domain_of:
- ConstraintResults
range: float
required: false
percent_mw:
name: percent_mw
description: "Actual MW flow as percent of limit.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.percentMW
multivalued: false
domain_of:
- ConstraintResults
range: float
required: false
shadow_price:
name: shadow_price
description: "Shadow Price ($/MW) for the commodity. Shadow price for the corresponding\
\ constraint.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.shadowPrice
multivalued: false
domain_of:
- ConstraintResults
- SecurityConstraintsClearing
range: float
required: false
update_time_stamp:
name: update_time_stamp
description: "Update time stamp.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ConstraintResults.updateTimeStamp
multivalued: false
domain_of:
- Trade
- Instructions
- ConstraintResults
- PnodeResults
- TradingHubPrice
- ResourceAwardInstruction
- RUCAwardInstruction
- LoadFollowingOperatorInput
- DopInstruction
- ExpectedEnergy
- ResourceDispatchResults
- AllocationResult
- Commitments
- RMROperatorInput
- AuxiliaryCost
- FiveMinAuxiliaryData
- TenMinAuxiliaryData
range: date
required: false
update_type:
name: update_type
description: "MQS change type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ConstraintResults.updateType
multivalued: false
domain_of:
- BidSelfSched
- Instructions
- ConstraintResults
- PnodeResults
- ResourceAwardInstruction
- RUCAwardInstruction
- LoadFollowingOperatorInput
- DopInstruction
- ResourceDispatchResults
- Commitments
- RMROperatorInput
range: MQSCHGType
required: false
update_user:
name: update_user
description: "Updated user.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ConstraintResults.updateUser
multivalued: false
domain_of:
- Trade
- Instructions
- ConstraintResults
- PnodeResults
- TradingHubPrice
- ResourceAwardInstruction
- RUCAwardInstruction
- LoadFollowingOperatorInput
- DopInstruction
- ExpectedEnergy
- ResourceDispatchResults
- AllocationResult
- Commitments
- RMROperatorInput
- AuxiliaryCost
- FiveMinAuxiliaryData
- TenMinAuxiliaryData
range: string
required: false
mkt_contingency:
name: mkt_contingency
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ConstraintResults.MktContingency
multivalued: false
domain_of:
- ContingencyConstraintLimit
- ConstraintResults
range: MktContingency
required: true
flowgate:
name: flowgate
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ConstraintResults.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: true
constraint_clearing:
name: constraint_clearing
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.ConstraintClearing
multivalued: false
domain_of:
- ConstraintResults
range: ConstraintClearing
required: false
class_uri: cim:ConstraintResults
Induced
name: ConstraintResults
description: "Provides the Market results for the constraint processing for either\
\ the DAM or RTM. The data includes the constraint type (binding or violated), the\
\ solved value for the constraint, and the associated shadow price.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
base_flow:
name: base_flow
description: "Branch base Power Flow.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.baseFlow
multivalued: false
alias: base_flow
owner: ConstraintResults
domain_of:
- ConstraintResults
range: float
required: false
bglimit:
name: bglimit
description: "This value is determined in DA and RTM. The SCUC optimization ensures\
\ that the MW flow on the Branch Group will not exceed this limit in the relevant\
\ direction. \r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.BGLimit
multivalued: false
alias: bglimit
owner: ConstraintResults
domain_of:
- ConstraintResults
range: float
required: false
bgtrres_cap:
name: bgtrres_cap
description: "Branch Group TR Reservation Capacity - This value is determined\
\ in DA and RTM. It is the amount of spare transmission capacity that is left\
\ for the TR holder to use. \r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.BGTRResCap
multivalued: false
alias: bgtrres_cap
owner: ConstraintResults
domain_of:
- ConstraintResults
range: float
required: false
binding_limit:
name: binding_limit
description: "MW Limit.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.bindingLimit
multivalued: false
alias: binding_limit
owner: ConstraintResults
domain_of:
- ConstraintResults
range: float
required: false
cleared_value:
name: cleared_value
description: "Cleared MW.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.clearedValue
multivalued: false
alias: cleared_value
owner: ConstraintResults
domain_of:
- ConstraintResults
- InterTieResults
range: float
required: false
competitive_path_constraint:
name: competitive_path_constraint
description: "Non-competitive path constraint Flag\"(Y/N) indicating whether\
\ the shadow price on a non-competitive path was non-zero.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.competitivePathConstraint
multivalued: false
alias: competitive_path_constraint
owner: ConstraintResults
domain_of:
- ConstraintResults
range: YesNo
required: false
constraint_type:
name: constraint_type
description: "Type of constraint.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.constraintType
multivalued: false
alias: constraint_type
owner: ConstraintResults
domain_of:
- ConstraintResults
range: ResultsConstraintType
required: false
limit_flag:
name: limit_flag
description: "Limit flag ('Maximum', 'Minimum').\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.limitFlag
multivalued: false
alias: limit_flag
owner: ConstraintResults
domain_of:
- ConstraintResults
- MarketRegionResults
range: ConstraintLimitType
required: false
optimization_flag:
name: optimization_flag
description: "Included in optimization Y/N.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.optimizationFlag
multivalued: false
alias: optimization_flag
owner: ConstraintResults
domain_of:
- ConstraintResults
range: YesNo
required: false
overload_mw:
name: overload_mw
description: "Transmission overload MW.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.overloadMW
multivalued: false
alias: overload_mw
owner: ConstraintResults
domain_of:
- ConstraintResults
range: float
required: false
percent_mw:
name: percent_mw
description: "Actual MW flow as percent of limit.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.percentMW
multivalued: false
alias: percent_mw
owner: ConstraintResults
domain_of:
- ConstraintResults
range: float
required: false
shadow_price:
name: shadow_price
description: "Shadow Price ($/MW) for the commodity. Shadow price for the corresponding\
\ constraint.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.shadowPrice
multivalued: false
alias: shadow_price
owner: ConstraintResults
domain_of:
- ConstraintResults
- SecurityConstraintsClearing
range: float
required: false
update_time_stamp:
name: update_time_stamp
description: "Update time stamp.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ConstraintResults.updateTimeStamp
multivalued: false
alias: update_time_stamp
owner: ConstraintResults
domain_of:
- Trade
- Instructions
- ConstraintResults
- PnodeResults
- TradingHubPrice
- ResourceAwardInstruction
- RUCAwardInstruction
- LoadFollowingOperatorInput
- DopInstruction
- ExpectedEnergy
- ResourceDispatchResults
- AllocationResult
- Commitments
- RMROperatorInput
- AuxiliaryCost
- FiveMinAuxiliaryData
- TenMinAuxiliaryData
range: date
required: false
update_type:
name: update_type
description: "MQS change type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ConstraintResults.updateType
multivalued: false
alias: update_type
owner: ConstraintResults
domain_of:
- BidSelfSched
- Instructions
- ConstraintResults
- PnodeResults
- ResourceAwardInstruction
- RUCAwardInstruction
- LoadFollowingOperatorInput
- DopInstruction
- ResourceDispatchResults
- Commitments
- RMROperatorInput
range: MQSCHGType
required: false
update_user:
name: update_user
description: "Updated user.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ConstraintResults.updateUser
multivalued: false
alias: update_user
owner: ConstraintResults
domain_of:
- Trade
- Instructions
- ConstraintResults
- PnodeResults
- TradingHubPrice
- ResourceAwardInstruction
- RUCAwardInstruction
- LoadFollowingOperatorInput
- DopInstruction
- ExpectedEnergy
- ResourceDispatchResults
- AllocationResult
- Commitments
- RMROperatorInput
- AuxiliaryCost
- FiveMinAuxiliaryData
- TenMinAuxiliaryData
range: string
required: false
mkt_contingency:
name: mkt_contingency
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ConstraintResults.MktContingency
multivalued: false
alias: mkt_contingency
owner: ConstraintResults
domain_of:
- ContingencyConstraintLimit
- ConstraintResults
range: MktContingency
required: true
flowgate:
name: flowgate
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ConstraintResults.Flowgate
multivalued: false
alias: flowgate
owner: ConstraintResults
domain_of:
- FTR
- MktLine
- ViolationLimit
- HostControlArea
- RegisteredInterTie
- SchedulingPoint
- SecurityConstraints
- TransmissionInterfaceRightEntitlement
- ContractDistributionFactor
- ConstraintResults
- GeneratingUnitDynamicValues
- CongestionRevenueRight
- GenericConstraints
- TransmissionCapacity
- MktTerminal
- FlowgateValue
- FlowgateRelief
- MktPowerTransformer
- InterTieResults
range: Flowgate
required: true
constraint_clearing:
name: constraint_clearing
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ConstraintResults.ConstraintClearing
multivalued: false
alias: constraint_clearing
owner: ConstraintResults
domain_of:
- ConstraintResults
range: ConstraintClearing
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: ConstraintResults
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: ConstraintResults
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: ConstraintResults
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: ConstraintResults
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: ConstraintResults
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: ConstraintResults
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: ConstraintResults
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: ConstraintResults
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
class_uri: cim:ConstraintResults