Class: PendingCalculation

_When present, a scalar conversion that needs to be applied to every IntervalReading.value contained in IntervalBlock. This conversion results in a new associated ReadingType, reflecting the true dimensions of IntervalReading values after the conversion. _

__

URI: cim:PendingCalculation

 classDiagram
    class PendingCalculation
      PendingCalculation : interval_blocks

          PendingCalculation --> IntervalBlock : interval_blocks

      PendingCalculation : multiply_before_add

      PendingCalculation : offset

      PendingCalculation : reading_type

          PendingCalculation --> ReadingType : reading_type

      PendingCalculation : scalar_denominator

      PendingCalculation : scalar_float

      PendingCalculation : scalar_numerator

Slots

Name	Cardinality and Range	Description	Inheritance
multiply_before_add	0..1 Boolean	Whether scalars should be applied before adding the 'offset'	direct
offset	0..1 Integer	(if applicable) Offset to be added as well as multiplication using scalars	direct
scalar_denominator	0..1 Integer	(if scalar is rational number) When 'IntervalReading	direct
scalar_float	0..1 Float	(if scalar is floating number) When multiplied with 'IntervalReading	direct
scalar_numerator	0..1 Integer	(if scalar is integer or rational number) When the scalar is a simple intege...	direct
reading_type	1..1 ReadingType	Reading type resulting from this pending conversion	direct
interval_blocks	0..* IntervalBlock	All blocks of interval reading values to which this pending conversion applie...	direct

Usages

used by	used in	type	used
ReadingType	pending_calculation	range	PendingCalculation
IntervalBlock	pending_calculation	range	PendingCalculation

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: PendingCalculation
description: "When present, a scalar conversion that needs to be applied to every\
  \ IntervalReading.value contained in IntervalBlock. This conversion results in a\
  \ new associated ReadingType, reflecting the true dimensions of IntervalReading\
  \ values after the conversion.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
attributes:
  multiply_before_add:
    name: multiply_before_add
    description: Whether scalars should be applied before adding the 'offset'.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PendingCalculation.multiplyBeforeAdd
    multivalued: false
    domain_of:
    - PendingCalculation
    range: boolean
    required: false
  offset:
    name: offset
    description: (if applicable) Offset to be added as well as multiplication using
      scalars.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PendingCalculation.offset
    multivalued: false
    domain_of:
    - TimeSchedule
    - PendingCalculation
    - BillDeterminant
    range: integer
    required: false
  scalar_denominator:
    name: scalar_denominator
    description: "(if scalar is rational number) When 'IntervalReading.value' is multiplied\
      \ by 'scalarNumerator' and divided by this value, it causes a unit of measure\
      \ conversion to occur, resulting in the 'ReadingType.unit'.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PendingCalculation.scalarDenominator
    multivalued: false
    domain_of:
    - PendingCalculation
    range: integer
    required: false
  scalar_float:
    name: scalar_float
    description: "(if scalar is floating number) When multiplied with 'IntervalReading.value',\
      \ it causes a unit of measure conversion to occur, according to the 'ReadingType.unit'.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PendingCalculation.scalarFloat
    multivalued: false
    domain_of:
    - PendingCalculation
    range: float
    required: false
  scalar_numerator:
    name: scalar_numerator
    description: (if scalar is integer or rational number)  When the scalar is a simple
      integer, and this attribute is presented alone and multiplied with 'IntervalReading.value',
      it causes a unit of measure conversion to occur, resulting in the 'ReadingType.unit'.
      It is never used in conjunction with 'scalarFloat', only with 'scalarDenominator'.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PendingCalculation.scalarNumerator
    multivalued: false
    domain_of:
    - PendingCalculation
    range: integer
    required: false
  reading_type:
    name: reading_type
    description: Reading type resulting from this pending conversion.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PendingCalculation.ReadingType
    multivalued: false
    domain_of:
    - MeterReadSchedule
    - ConsumptionTariffInterval
    - PendingCalculation
    - IntervalBlock
    - Reading
    - Channel
    range: ReadingType
    required: true
  interval_blocks:
    name: interval_blocks
    description: All blocks of interval reading values to which this pending conversion
      applies.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PendingCalculation.IntervalBlocks
    multivalued: true
    domain_of:
    - ReadingType
    - PendingCalculation
    - MeterReading
    - IntervalReading
    range: IntervalBlock
    required: false
class_uri: cim:PendingCalculation

Induced

name: PendingCalculation
description: "When present, a scalar conversion that needs to be applied to every\
  \ IntervalReading.value contained in IntervalBlock. This conversion results in a\
  \ new associated ReadingType, reflecting the true dimensions of IntervalReading\
  \ values after the conversion.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
attributes:
  multiply_before_add:
    name: multiply_before_add
    description: Whether scalars should be applied before adding the 'offset'.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PendingCalculation.multiplyBeforeAdd
    multivalued: false
    alias: multiply_before_add
    owner: PendingCalculation
    domain_of:
    - PendingCalculation
    range: boolean
    required: false
  offset:
    name: offset
    description: (if applicable) Offset to be added as well as multiplication using
      scalars.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PendingCalculation.offset
    multivalued: false
    alias: offset
    owner: PendingCalculation
    domain_of:
    - TimeSchedule
    - PendingCalculation
    - BillDeterminant
    range: integer
    required: false
  scalar_denominator:
    name: scalar_denominator
    description: "(if scalar is rational number) When 'IntervalReading.value' is multiplied\
      \ by 'scalarNumerator' and divided by this value, it causes a unit of measure\
      \ conversion to occur, resulting in the 'ReadingType.unit'.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PendingCalculation.scalarDenominator
    multivalued: false
    alias: scalar_denominator
    owner: PendingCalculation
    domain_of:
    - PendingCalculation
    range: integer
    required: false
  scalar_float:
    name: scalar_float
    description: "(if scalar is floating number) When multiplied with 'IntervalReading.value',\
      \ it causes a unit of measure conversion to occur, according to the 'ReadingType.unit'.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PendingCalculation.scalarFloat
    multivalued: false
    alias: scalar_float
    owner: PendingCalculation
    domain_of:
    - PendingCalculation
    range: float
    required: false
  scalar_numerator:
    name: scalar_numerator
    description: (if scalar is integer or rational number)  When the scalar is a simple
      integer, and this attribute is presented alone and multiplied with 'IntervalReading.value',
      it causes a unit of measure conversion to occur, resulting in the 'ReadingType.unit'.
      It is never used in conjunction with 'scalarFloat', only with 'scalarDenominator'.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PendingCalculation.scalarNumerator
    multivalued: false
    alias: scalar_numerator
    owner: PendingCalculation
    domain_of:
    - PendingCalculation
    range: integer
    required: false
  reading_type:
    name: reading_type
    description: Reading type resulting from this pending conversion.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PendingCalculation.ReadingType
    multivalued: false
    alias: reading_type
    owner: PendingCalculation
    domain_of:
    - MeterReadSchedule
    - ConsumptionTariffInterval
    - PendingCalculation
    - IntervalBlock
    - Reading
    - Channel
    range: ReadingType
    required: true
  interval_blocks:
    name: interval_blocks
    description: All blocks of interval reading values to which this pending conversion
      applies.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PendingCalculation.IntervalBlocks
    multivalued: true
    alias: interval_blocks
    owner: PendingCalculation
    domain_of:
    - ReadingType
    - PendingCalculation
    - MeterReading
    - IntervalReading
    range: IntervalBlock
    required: false
class_uri: cim:PendingCalculation