Skip to content

Class: FuelAllocationSchedule

_The amount of fuel of a given type which is allocated for consumption over a specified period of time. _

__

URI: cim:FuelAllocationSchedule

 classDiagram
    class FuelAllocationSchedule
      Curve <|-- FuelAllocationSchedule

      FuelAllocationSchedule : alias_name

      FuelAllocationSchedule : curve_datas

          FuelAllocationSchedule --> CurveData : curve_datas

      FuelAllocationSchedule : curve_style

          FuelAllocationSchedule --> CurveStyle : curve_style

      FuelAllocationSchedule : description

      FuelAllocationSchedule : diagram_objects

          FuelAllocationSchedule --> DiagramObject : diagram_objects

      FuelAllocationSchedule : fossil_fuel

          FuelAllocationSchedule --> FossilFuel : fossil_fuel

      FuelAllocationSchedule : fuel_allocation_end_date

      FuelAllocationSchedule : fuel_allocation_start_date

      FuelAllocationSchedule : fuel_type

          FuelAllocationSchedule --> FuelType : fuel_type

      FuelAllocationSchedule : instance_set

          FuelAllocationSchedule --> InstanceSet : instance_set

      FuelAllocationSchedule : m_rid

      FuelAllocationSchedule : max_fuel_allocation

      FuelAllocationSchedule : min_fuel_allocation

      FuelAllocationSchedule : names

          FuelAllocationSchedule --> Name : names

      FuelAllocationSchedule : properties_cimdata_object

          FuelAllocationSchedule --> ChangeSetMember : properties_cimdata_object

      FuelAllocationSchedule : targeting_cimdata_object

          FuelAllocationSchedule --> ChangeSetMember : targeting_cimdata_object

      FuelAllocationSchedule : thermal_generating_unit

          FuelAllocationSchedule --> ThermalGeneratingUnit : thermal_generating_unit

      FuelAllocationSchedule : x_multiplier

          FuelAllocationSchedule --> UnitMultiplier : x_multiplier

      FuelAllocationSchedule : x_unit

          FuelAllocationSchedule --> UnitSymbol : x_unit

      FuelAllocationSchedule : y_multiplier

          FuelAllocationSchedule --> UnitMultiplier : y_multiplier

      FuelAllocationSchedule : y_unit

          FuelAllocationSchedule --> UnitSymbol : y_unit

Inheritance

Slots

Name Cardinality and Range Description Inheritance
fuel_allocation_end_date 0..1
date		 The end time and date of the fuel allocation schedule direct
fuel_allocation_start_date 0..1
date		 The start time and date of the fuel allocation schedule direct
fuel_type 0..1
FuelType		 The type of fuel, which also indicates the corresponding measurement unit direct
max_fuel_allocation 0..1
Float		 The maximum amount of fuel that is allocated for consumption for the schedule... direct
min_fuel_allocation 0..1
Float		 The minimum amount of fuel that is allocated for consumption for the schedule... direct
thermal_generating_unit 1..1
ThermalGeneratingUnit		 A thermal generating unit may have one or more fuel allocation schedules direct
fossil_fuel 1..1
FossilFuel		 A fuel allocation schedule shall have a fossil fuel 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
ThermalGeneratingUnit fuel_allocation_schedules range FuelAllocationSchedule
FossilFuel fuel_allocation_schedules range FuelAllocationSchedule
MktThermalGeneratingUnit fuel_allocation_schedules range FuelAllocationSchedule

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: FuelAllocationSchedule
description: "The amount of fuel of a given type which is allocated for consumption\
  \ over a specified period of time.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Curve
attributes:
  fuel_allocation_end_date:
    name: fuel_allocation_end_date
    description: "The end time and date of the fuel allocation schedule.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.fuelAllocationEndDate
    multivalued: false
    domain_of:
    - FuelAllocationSchedule
    range: date
    required: false
  fuel_allocation_start_date:
    name: fuel_allocation_start_date
    description: "The start time and date of the fuel allocation schedule.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.fuelAllocationStartDate
    multivalued: false
    domain_of:
    - FuelAllocationSchedule
    range: date
    required: false
  fuel_type:
    name: fuel_type
    description: "The type of fuel, which also indicates the corresponding measurement\
      \ unit.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.fuelType
    multivalued: false
    domain_of:
    - FuelAllocationSchedule
    range: FuelType
    required: false
  max_fuel_allocation:
    name: max_fuel_allocation
    description: The maximum amount of fuel that is allocated for consumption for
      the scheduled time period.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.maxFuelAllocation
    multivalued: false
    domain_of:
    - FuelAllocationSchedule
    range: float
    required: false
  min_fuel_allocation:
    name: min_fuel_allocation
    description: The minimum amount of fuel that is allocated for consumption for
      the scheduled time period, e.g., based on a "take-or-pay" contract.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.minFuelAllocation
    multivalued: false
    domain_of:
    - FuelAllocationSchedule
    range: float
    required: false
  thermal_generating_unit:
    name: thermal_generating_unit
    description: A thermal generating unit may have one or more fuel allocation schedules.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:FuelAllocationSchedule.ThermalGeneratingUnit
    multivalued: false
    domain_of:
    - HeatRateCurve
    - FuelAllocationSchedule
    - FossilFuel
    - StartupModel
    - EmissionCurve
    - ShutdownCurve
    - IncrementalHeatRateCurve
    - CAESPlant
    - EmissionAccount
    - HeatInputCurve
    range: ThermalGeneratingUnit
    required: true
  fossil_fuel:
    name: fossil_fuel
    description: A fuel allocation schedule shall have a fossil fuel.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.FossilFuel
    multivalued: false
    domain_of:
    - FuelAllocationSchedule
    range: FossilFuel
    required: true
class_uri: cim:FuelAllocationSchedule

Induced

name: FuelAllocationSchedule
description: "The amount of fuel of a given type which is allocated for consumption\
  \ over a specified period of time.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Curve
attributes:
  fuel_allocation_end_date:
    name: fuel_allocation_end_date
    description: "The end time and date of the fuel allocation schedule.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.fuelAllocationEndDate
    multivalued: false
    alias: fuel_allocation_end_date
    owner: FuelAllocationSchedule
    domain_of:
    - FuelAllocationSchedule
    range: date
    required: false
  fuel_allocation_start_date:
    name: fuel_allocation_start_date
    description: "The start time and date of the fuel allocation schedule.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.fuelAllocationStartDate
    multivalued: false
    alias: fuel_allocation_start_date
    owner: FuelAllocationSchedule
    domain_of:
    - FuelAllocationSchedule
    range: date
    required: false
  fuel_type:
    name: fuel_type
    description: "The type of fuel, which also indicates the corresponding measurement\
      \ unit.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.fuelType
    multivalued: false
    alias: fuel_type
    owner: FuelAllocationSchedule
    domain_of:
    - FuelAllocationSchedule
    range: FuelType
    required: false
  max_fuel_allocation:
    name: max_fuel_allocation
    description: The maximum amount of fuel that is allocated for consumption for
      the scheduled time period.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.maxFuelAllocation
    multivalued: false
    alias: max_fuel_allocation
    owner: FuelAllocationSchedule
    domain_of:
    - FuelAllocationSchedule
    range: float
    required: false
  min_fuel_allocation:
    name: min_fuel_allocation
    description: The minimum amount of fuel that is allocated for consumption for
      the scheduled time period, e.g., based on a "take-or-pay" contract.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.minFuelAllocation
    multivalued: false
    alias: min_fuel_allocation
    owner: FuelAllocationSchedule
    domain_of:
    - FuelAllocationSchedule
    range: float
    required: false
  thermal_generating_unit:
    name: thermal_generating_unit
    description: A thermal generating unit may have one or more fuel allocation schedules.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:FuelAllocationSchedule.ThermalGeneratingUnit
    multivalued: false
    alias: thermal_generating_unit
    owner: FuelAllocationSchedule
    domain_of:
    - HeatRateCurve
    - FuelAllocationSchedule
    - FossilFuel
    - StartupModel
    - EmissionCurve
    - ShutdownCurve
    - IncrementalHeatRateCurve
    - CAESPlant
    - EmissionAccount
    - HeatInputCurve
    range: ThermalGeneratingUnit
    required: true
  fossil_fuel:
    name: fossil_fuel
    description: A fuel allocation schedule shall have a fossil fuel.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:FuelAllocationSchedule.FossilFuel
    multivalued: false
    alias: fossil_fuel
    owner: FuelAllocationSchedule
    domain_of:
    - FuelAllocationSchedule
    range: FossilFuel
    required: true
  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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    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: FuelAllocationSchedule
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:FuelAllocationSchedule