Class: InterchangeSchedule
_Interchange schedule class to hold information for interchange schedules such as import export type, energy type, and etc. _
__
classDiagram
class InterchangeSchedule
Curve <|-- InterchangeSchedule
InterchangeSchedule : alias_name
InterchangeSchedule : check_out_type
InterchangeSchedule --> CheckOutType : check_out_type
InterchangeSchedule : curve_datas
InterchangeSchedule --> CurveData : curve_datas
InterchangeSchedule : curve_style
InterchangeSchedule --> CurveStyle : curve_style
InterchangeSchedule : description
InterchangeSchedule : diagram_objects
InterchangeSchedule --> DiagramObject : diagram_objects
InterchangeSchedule : direction_type
InterchangeSchedule --> InterTieDirection : direction_type
InterchangeSchedule : energy_type
InterchangeSchedule --> MarketProductType : energy_type
InterchangeSchedule : instance_set
InterchangeSchedule --> InstanceSet : instance_set
InterchangeSchedule : inter_tie
InterchangeSchedule --> SchedulingPoint : inter_tie
InterchangeSchedule : interchange_etcdata
InterchangeSchedule --> InterchangeETCData : interchange_etcdata
InterchangeSchedule : interval_length
InterchangeSchedule : m_rid
InterchangeSchedule : market_type
InterchangeSchedule --> MarketType : market_type
InterchangeSchedule : names
InterchangeSchedule --> Name : names
InterchangeSchedule : operating_date
InterchangeSchedule : out_of_market_type
InterchangeSchedule : properties_cimdata_object
InterchangeSchedule --> ChangeSetMember : properties_cimdata_object
InterchangeSchedule : registered_inter_tie
InterchangeSchedule --> RegisteredInterTie : registered_inter_tie
InterchangeSchedule : schedule_type
InterchangeSchedule --> EnergyProductType : schedule_type
InterchangeSchedule : targeting_cimdata_object
InterchangeSchedule --> ChangeSetMember : targeting_cimdata_object
InterchangeSchedule : wcr_id
InterchangeSchedule : x_multiplier
InterchangeSchedule --> UnitMultiplier : x_multiplier
InterchangeSchedule : x_unit
InterchangeSchedule --> UnitSymbol : x_unit
InterchangeSchedule : y_multiplier
InterchangeSchedule --> UnitMultiplier : y_multiplier
InterchangeSchedule : y_unit
InterchangeSchedule --> UnitSymbol : y_unit
Inheritance
- IdentifiedObject
- Curve
- InterchangeSchedule
- Curve
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| check_out_type | 0..1 CheckOutType |
To indicate a check out type such as adjusted capacity or dispatch capacity | direct |
| direction_type | 0..1 InterTieDirection |
Import or export | direct |
| energy_type | 0..1 MarketProductType |
Energy product type | direct |
| interval_length | 0..1 Integer |
Interval length | direct |
| market_type | 0..1 MarketType |
Market type | direct |
| operating_date | 0..1 date |
Operating date, hour | direct |
| out_of_market_type | 0..1 Boolean |
To indicate an out-of-market (OOM) schedule | direct |
| schedule_type | 0..1 EnergyProductType |
Schedule type | direct |
| wcr_id | 0..1 String |
Wheeling Counter-Resource ID (required when Schedule Type=Wheel) | direct |
| interchange_etcdata | 0..* InterchangeETCData |
direct | |
| registered_inter_tie | 0..1 RegisteredInterTie |
direct | |
| inter_tie | 0..1 SchedulingPoint |
direct | |
| curve_style | 0..1 CurveStyle |
The style or shape of the curve | Curve |
| x_multiplier | 0..1 UnitMultiplier |
Multiplier for X-axis | Curve |
| x_unit | 0..1 UnitSymbol |
The X-axis units of measure | Curve |
| y_multiplier | 0..1 UnitMultiplier |
Multiplier for Y3-axis | Curve |
| y_unit | 0..1 UnitSymbol |
The Y3-axis units of measure | Curve |
| curve_datas | 0..* CurveData |
The point data values that define this curve | Curve |
| 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 |
|---|---|---|---|
| RegisteredInterTie | interchange_schedule | range | InterchangeSchedule |
| InterchangeETCData | interchange_schedule | range | InterchangeSchedule |
| SchedulingPoint | interchange_schedule | range | InterchangeSchedule |
Identifier and Mapping Information
Schema Source
- from schema: https://cim.ucaiug.io/ns#TC57CIM
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | cim:InterchangeSchedule |
| native | cim:InterchangeSchedule |
LinkML Source
Direct
name: InterchangeSchedule
description: "Interchange schedule class to hold information for interchange schedules\
\ such as import export type, energy type, and etc.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Curve
attributes:
check_out_type:
name: check_out_type
description: "To indicate a check out type such as adjusted capacity or dispatch\
\ capacity.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.checkOutType
multivalued: false
domain_of:
- InterchangeSchedule
range: CheckOutType
required: false
direction_type:
name: direction_type
description: "Import or export.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.directionType
multivalued: false
domain_of:
- InterchangeSchedule
range: InterTieDirection
required: false
energy_type:
name: energy_type
description: "Energy product type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.energyType
multivalued: false
domain_of:
- InterchangeSchedule
range: MarketProductType
required: false
interval_length:
name: interval_length
description: "Interval length.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.intervalLength
multivalued: false
domain_of:
- InterchangeSchedule
range: integer
required: false
market_type:
name: market_type
description: "Market type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:InterchangeSchedule.marketType
multivalued: false
domain_of:
- MarketRun
- PlannedMarket
- Bid
- MPMTestThreshold
- DistributionFactorSet
- Trade
- InterchangeSchedule
- PriceDescriptor
- TradingHubPrice
- BidPriceCap
- BilateralTransaction
- AuxiliaryCost
range: MarketType
required: false
operating_date:
name: operating_date
description: "Operating date, hour.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.operatingDate
multivalued: false
domain_of:
- InterchangeSchedule
range: date
required: false
out_of_market_type:
name: out_of_market_type
description: "To indicate an out-of-market (OOM) schedule.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.outOfMarketType
multivalued: false
domain_of:
- InterchangeSchedule
range: boolean
required: false
schedule_type:
name: schedule_type
description: "Schedule type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.scheduleType
multivalued: false
domain_of:
- InterchangeSchedule
range: EnergyProductType
required: false
wcr_id:
name: wcr_id
description: "Wheeling Counter-Resource ID (required when Schedule Type=Wheel).\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.wcrID
multivalued: false
domain_of:
- InterchangeSchedule
range: string
required: false
interchange_etcdata:
name: interchange_etcdata
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.InterchangeETCData
multivalued: true
domain_of:
- InterchangeSchedule
range: InterchangeETCData
required: false
registered_inter_tie:
name: registered_inter_tie
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:InterchangeSchedule.RegisteredInterTie
multivalued: false
domain_of:
- Flowgate
- InterTieBid
- WheelingCounterParty
- InterchangeSchedule
- InterTieDispatchResponse
range: RegisteredInterTie
required: false
inter_tie:
name: inter_tie
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:InterchangeSchedule.InterTie
multivalued: false
domain_of:
- RegisteredResource
- Flowgate
- InterchangeSchedule
range: SchedulingPoint
required: false
class_uri: cim:InterchangeSchedule
Induced
name: InterchangeSchedule
description: "Interchange schedule class to hold information for interchange schedules\
\ such as import export type, energy type, and etc.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Curve
attributes:
check_out_type:
name: check_out_type
description: "To indicate a check out type such as adjusted capacity or dispatch\
\ capacity.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.checkOutType
multivalued: false
alias: check_out_type
owner: InterchangeSchedule
domain_of:
- InterchangeSchedule
range: CheckOutType
required: false
direction_type:
name: direction_type
description: "Import or export.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.directionType
multivalued: false
alias: direction_type
owner: InterchangeSchedule
domain_of:
- InterchangeSchedule
range: InterTieDirection
required: false
energy_type:
name: energy_type
description: "Energy product type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.energyType
multivalued: false
alias: energy_type
owner: InterchangeSchedule
domain_of:
- InterchangeSchedule
range: MarketProductType
required: false
interval_length:
name: interval_length
description: "Interval length.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.intervalLength
multivalued: false
alias: interval_length
owner: InterchangeSchedule
domain_of:
- InterchangeSchedule
range: integer
required: false
market_type:
name: market_type
description: "Market type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:InterchangeSchedule.marketType
multivalued: false
alias: market_type
owner: InterchangeSchedule
domain_of:
- MarketRun
- PlannedMarket
- Bid
- MPMTestThreshold
- DistributionFactorSet
- Trade
- InterchangeSchedule
- PriceDescriptor
- TradingHubPrice
- BidPriceCap
- BilateralTransaction
- AuxiliaryCost
range: MarketType
required: false
operating_date:
name: operating_date
description: "Operating date, hour.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.operatingDate
multivalued: false
alias: operating_date
owner: InterchangeSchedule
domain_of:
- InterchangeSchedule
range: date
required: false
out_of_market_type:
name: out_of_market_type
description: "To indicate an out-of-market (OOM) schedule.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.outOfMarketType
multivalued: false
alias: out_of_market_type
owner: InterchangeSchedule
domain_of:
- InterchangeSchedule
range: boolean
required: false
schedule_type:
name: schedule_type
description: "Schedule type.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.scheduleType
multivalued: false
alias: schedule_type
owner: InterchangeSchedule
domain_of:
- InterchangeSchedule
range: EnergyProductType
required: false
wcr_id:
name: wcr_id
description: "Wheeling Counter-Resource ID (required when Schedule Type=Wheel).\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.wcrID
multivalued: false
alias: wcr_id
owner: InterchangeSchedule
domain_of:
- InterchangeSchedule
range: string
required: false
interchange_etcdata:
name: interchange_etcdata
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:InterchangeSchedule.InterchangeETCData
multivalued: true
alias: interchange_etcdata
owner: InterchangeSchedule
domain_of:
- InterchangeSchedule
range: InterchangeETCData
required: false
registered_inter_tie:
name: registered_inter_tie
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:InterchangeSchedule.RegisteredInterTie
multivalued: false
alias: registered_inter_tie
owner: InterchangeSchedule
domain_of:
- Flowgate
- InterTieBid
- WheelingCounterParty
- InterchangeSchedule
- InterTieDispatchResponse
range: RegisteredInterTie
required: false
inter_tie:
name: inter_tie
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:InterchangeSchedule.InterTie
multivalued: false
alias: inter_tie
owner: InterchangeSchedule
domain_of:
- RegisteredResource
- Flowgate
- InterchangeSchedule
range: SchedulingPoint
required: false
curve_style:
name: curve_style
description: The style or shape of the curve.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Curve.curveStyle
multivalued: false
alias: curve_style
owner: InterchangeSchedule
domain_of:
- Curve
range: CurveStyle
required: false
x_multiplier:
name: x_multiplier
description: Multiplier for X-axis.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Curve.xMultiplier
multivalued: false
alias: x_multiplier
owner: InterchangeSchedule
domain_of:
- Curve
range: UnitMultiplier
required: false
x_unit:
name: x_unit
description: The X-axis units of measure.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Curve.xUnit
multivalued: false
alias: x_unit
owner: InterchangeSchedule
domain_of:
- Curve
range: UnitSymbol
required: false
y_multiplier:
name: y_multiplier
description: Multiplier for Y3-axis.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Curve.y3Multiplier
multivalued: false
alias: y_multiplier
owner: InterchangeSchedule
domain_of:
- Curve
- DERMonitorableParameter
range: UnitMultiplier
required: false
y_unit:
name: y_unit
description: The Y3-axis units of measure.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Curve.y3Unit
multivalued: false
alias: y_unit
owner: InterchangeSchedule
domain_of:
- Curve
- DERMonitorableParameter
range: UnitSymbol
required: false
curve_datas:
name: curve_datas
description: The point data values that define this curve.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Curve.CurveDatas
multivalued: true
alias: curve_datas
owner: InterchangeSchedule
domain_of:
- Curve
range: CurveData
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: InterchangeSchedule
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: InterchangeSchedule
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: InterchangeSchedule
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: InterchangeSchedule
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: InterchangeSchedule
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: InterchangeSchedule
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: InterchangeSchedule
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: InterchangeSchedule
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
class_uri: cim:InterchangeSchedule