Skip to content

Class: InflowForecast

Natural water inflow to a reservoir, usually forecasted from predicted rain and snowmelt. Typically in one hour increments for up to 10 days. The forecast is given in average cubic meters per second over the time increment.

URI: cim:InflowForecast

 classDiagram
    class InflowForecast
      RegularIntervalSchedule <|-- InflowForecast

      InflowForecast : alias_name

      InflowForecast : description

      InflowForecast : diagram_objects

          InflowForecast --> DiagramObject : diagram_objects

      InflowForecast : end_time

      InflowForecast : instance_set

          InflowForecast --> InstanceSet : instance_set

      InflowForecast : m_rid

      InflowForecast : names

          InflowForecast --> Name : names

      InflowForecast : properties_cimdata_object

          InflowForecast --> ChangeSetMember : properties_cimdata_object

      InflowForecast : reservoir

          InflowForecast --> Reservoir : reservoir

      InflowForecast : start_time

      InflowForecast : targeting_cimdata_object

          InflowForecast --> ChangeSetMember : targeting_cimdata_object

      InflowForecast : time_points

          InflowForecast --> RegularTimePoint : time_points

      InflowForecast : time_step

          InflowForecast --> Seconds : time_step

      InflowForecast : value_multiplier

          InflowForecast --> UnitMultiplier : value_multiplier

      InflowForecast : value_unit

          InflowForecast --> UnitSymbol : value_unit

Inheritance

Slots

Name Cardinality and Range Description Inheritance
reservoir 1..1
Reservoir
A reservoir may have a "natural" inflow forecast direct
end_time 0..1
date
The time for the last time point RegularIntervalSchedule
time_step 0..1
Seconds
The time between each pair of subsequent regular time points in sequence orde... RegularIntervalSchedule
time_points 1..*
RegularTimePoint
The regular interval time point data values that define this schedule RegularIntervalSchedule
start_time 0..1
date
The time for the first time point BasicIntervalSchedule
value_multiplier 0..1
UnitMultiplier
Multiplier for value2 BasicIntervalSchedule
value_unit 0..1
UnitSymbol
Value2 units of measure BasicIntervalSchedule
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
Reservoir inflow_forecasts range InflowForecast

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: InflowForecast
description: Natural water inflow to a reservoir, usually forecasted from predicted
  rain and snowmelt. Typically in one hour increments for up to 10 days. The forecast
  is given in average cubic meters per second over the time increment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: RegularIntervalSchedule
attributes:
  reservoir:
    name: reservoir
    description: A reservoir may have a "natural" inflow forecast.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:InflowForecast.Reservoir
    multivalued: false
    domain_of:
    - HydroPowerPlant
    - LevelVsVolumeCurve
    - InflowForecast
    - TargetLevelSchedule
    range: Reservoir
    required: true
class_uri: cim:InflowForecast

Induced

name: InflowForecast
description: Natural water inflow to a reservoir, usually forecasted from predicted
  rain and snowmelt. Typically in one hour increments for up to 10 days. The forecast
  is given in average cubic meters per second over the time increment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: RegularIntervalSchedule
attributes:
  reservoir:
    name: reservoir
    description: A reservoir may have a "natural" inflow forecast.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:InflowForecast.Reservoir
    multivalued: false
    alias: reservoir
    owner: InflowForecast
    domain_of:
    - HydroPowerPlant
    - LevelVsVolumeCurve
    - InflowForecast
    - TargetLevelSchedule
    range: Reservoir
    required: true
  end_time:
    name: end_time
    description: The time for the last time point.  The value can be a time of day,
      not a specific date.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegularIntervalSchedule.endTime
    multivalued: false
    alias: end_time
    owner: InflowForecast
    domain_of:
    - RegularIntervalSchedule
    - BidError
    - TradeError
    - LoadFollowingInst
    range: date
    required: false
  time_step:
    name: time_step
    description: "The time between each pair of subsequent regular time points in\
      \ sequence order.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:RegularIntervalSchedule.timeStep
    multivalued: false
    alias: time_step
    owner: InflowForecast
    domain_of:
    - RegularIntervalSchedule
    range: Seconds
    required: false
  time_points:
    name: time_points
    description: The regular interval time point data values that define this schedule.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:RegularIntervalSchedule.TimePoints
    multivalued: true
    alias: time_points
    owner: InflowForecast
    domain_of:
    - TimeSchedule
    - RegularIntervalSchedule
    - IrregularIntervalSchedule
    range: RegularTimePoint
    required: true
  start_time:
    name: start_time
    description: The time for the first time point.  The value can be a time of day,
      not a specific date.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:BasicIntervalSchedule.startTime
    multivalued: false
    alias: start_time
    owner: InflowForecast
    domain_of:
    - TimeTariffInterval
    - DispatchSchedule
    - BasicIntervalSchedule
    - Bid
    - Trade
    - BidError
    - InterTieDispatchResponse
    - TradeError
    - LoadFollowingInst
    - DispatchInstReply
    range: date
    required: false
  value_multiplier:
    name: value_multiplier
    description: Multiplier for value2.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BasicIntervalSchedule.value2Multiplier
    multivalued: false
    alias: value_multiplier
    owner: InflowForecast
    domain_of:
    - BasicIntervalSchedule
    range: UnitMultiplier
    required: false
  value_unit:
    name: value_unit
    description: Value2 units of measure.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BasicIntervalSchedule.value2Unit
    multivalued: false
    alias: value_unit
    owner: InflowForecast
    domain_of:
    - BasicIntervalSchedule
    range: UnitSymbol
    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: InflowForecast
    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: InflowForecast
    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: InflowForecast
    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: InflowForecast
    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: InflowForecast
    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: InflowForecast
    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: InflowForecast
    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: InflowForecast
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:InflowForecast