Class: MeasureSchedule

A set of measures, all in the same unit, where the values are defined through a schedule of steps. The initial value may be defined either as part of the steps, or using the single amount attribute.

URI: common_domain_model:MeasureSchedule

 classDiagram
    class MeasureSchedule
    click MeasureSchedule href "../MeasureSchedule/"
      MeasureBase <|-- MeasureSchedule
        click MeasureBase href "../MeasureBase/"


      MeasureSchedule <|-- QuantitySchedule
        click QuantitySchedule href "../QuantitySchedule/"
      MeasureSchedule <|-- PriceSchedule
        click PriceSchedule href "../PriceSchedule/"


      MeasureSchedule : datedValue





        MeasureSchedule --> "*" DatedValue : datedValue
        click DatedValue href "../DatedValue/"



      MeasureSchedule : unit





        MeasureSchedule --> "0..1" UnitType : unit
        click UnitType href "../UnitType/"



      MeasureSchedule : value

Inheritance

MeasureBase
- MeasureSchedule
  - QuantitySchedule
  - PriceSchedule

Slots

Name	Cardinality and Range	Description	Inheritance
datedValue	* DatedValue	A schedule of step date and value pairs	direct
value	0..1 Decimal	Specifies the value of the measure as a number	MeasureBase
unit	0..1 UnitType	Qualifies the unit by which the amount is measured	MeasureBase

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions

In Subsets

CdmBaseMath

Comments

Rosetta condition: ValueExists — value exists or datedValue exists

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/lmodel/common-domain-model

Mappings

Mapping Type	Mapped Value
self	common_domain_model:MeasureSchedule
native	common_domain_model:MeasureSchedule

LinkML Source

Direct

name: MeasureSchedule
description: A set of measures, all in the same unit, where the values are defined
  through a schedule of steps. The initial value may be defined either as part of
  the steps, or using the single amount attribute.
comments:
- 'Rosetta condition: ValueExists — value exists or datedValue exists'
in_subset:
- cdm_base_math
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: MeasureBase
slots:
- datedValue
rules:
- postconditions:
    any_of:
    - slot_conditions:
        value:
          name: value
          required: true
    - slot_conditions:
        datedValue:
          name: datedValue
          required: true
  description: A schedule may be specified as a single value or as a set of date-value
    pairs. Both attributes may be specified, in which case the single amount number
    is the initial value.

Induced

name: MeasureSchedule
description: A set of measures, all in the same unit, where the values are defined
  through a schedule of steps. The initial value may be defined either as part of
  the steps, or using the single amount attribute.
comments:
- 'Rosetta condition: ValueExists — value exists or datedValue exists'
in_subset:
- cdm_base_math
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: MeasureBase
attributes:
  datedValue:
    name: datedValue
    description: A schedule of step date and value pairs. On each step date the associated
      step value becomes effective. The step dates are used to order the steps by
      ascending order. This attribute is optional so the data type may be used to
      define a schedule with a single value.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: MeasureSchedule
    domain_of:
    - MeasureSchedule
    - Schedule
    range: DatedValue
    multivalued: true
    inlined: true
    inlined_as_list: true
  value:
    name: value
    description: Specifies the value of the measure as a number. Optional because
      in a measure vector or schedule, this single value may be omitted.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: MeasureSchedule
    domain_of:
    - MeasureBase
    - Schedule
    - DatedValue
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AdjustmentFactor
    - AccrualFactor
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    - CSAThresholdVariableSet
    - CSAMinimumTransferAmountVariableSet
    - MasterAgreementVariableSet
    range: decimal
  unit:
    name: unit
    description: Qualifies the unit by which the amount is measured. Optional because
      a measure may be unit-less (e.g. when representing a ratio between amounts in
      the same unit).
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: MeasureSchedule
    domain_of:
    - MeasureBase
    - Qty
    - Term
    range: UnitType
rules:
- postconditions:
    any_of:
    - slot_conditions:
        value:
          name: value
          required: true
    - slot_conditions:
        datedValue:
          name: datedValue
          required: true
  description: A schedule may be specified as a single value or as a set of date-value
    pairs. Both attributes may be specified, in which case the single amount number
    is the initial value.