Skip to content

Class: MeasureBase

Provides an abstract type to define a measure as a single number or a schedule associated to a unit. This type is abstract because all its attributes are optional. The types that extend it can specify further existence constraints.

URI: common_domain_model:MeasureBase

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

      MeasureBase <|-- Measure
        click Measure href "../Measure/"
      MeasureBase <|-- QuantitySchedule
        click QuantitySchedule href "../QuantitySchedule/"
      MeasureBase <|-- PriceSchedule
        click PriceSchedule href "../PriceSchedule/"
      

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

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

        
      MeasureBase : value
        
      
Name Cardinality and Range Description Inheritance
unit 0..1
UnitType
Qualifies the unit by which the amount is measured direct
value 0..1
Decimal
The initial rate or amount, as the case may be Schedule
datedValue *
DatedValue
The schedule of step date and value pairs Schedule
Expressions & Logic

The class must satisfy all of:

  • AnonymousClassExpression({ ‘description’: (’From Schedule. ValueExists: 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.’), ‘any_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘value’: SlotDefinition({‘name’: ‘value’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘datedValue’: SlotDefinition({‘name’: ‘datedValue’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} })] })
Mapping Type Mapped Value
self common_domain_model:MeasureBase
native common_domain_model:MeasureBase
name: MeasureBase
description: Provides an abstract type to define a measure as a single number or a
schedule associated to a unit. This type is abstract because all its attributes
are optional. The types that extend it can specify further existence constraints.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Schedule
slots:
- unit
slot_usage:
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).
range: UnitType
all_of:
- description: 'From Schedule. ValueExists: 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.'
any_of:
- slot_conditions:
value:
name: value
value_presence: PRESENT
- slot_conditions:
datedValue:
name: datedValue
value_presence: PRESENT
name: MeasureBase
description: Provides an abstract type to define a measure as a single number or a
schedule associated to a unit. This type is abstract because all its attributes
are optional. The types that extend it can specify further existence constraints.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Schedule
slot_usage:
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).
range: UnitType
attributes:
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: MeasureBase
domain_of:
- MeasureBase
range: UnitType
value:
name: value
description: The initial rate or amount, as the case may be. An initial rate of
5% would be represented as 0.05.
from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_math
owner: MeasureBase
domain_of:
- DatedValue
- Schedule
- Taxonomy
- TaxonomyClassification
- CodeValue
- AccrualFactor
- AdjustmentFactor
- ClauseLibraryVariableSet
- CSAMinimumTransferAmountVariableSet
- CSAThresholdVariableSet
- DisputeResolution
- OtherEligibleAndPostedSupport
range: decimal
datedValue:
name: datedValue
description: The schedule of step date and value pairs. On each step date the
associated step value becomes effective. A list of steps may be ordered in the
document by ascending step date. An FpML document containing an unordered list
of steps is still regarded as a conformant document.
from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_math
rank: 1000
owner: MeasureBase
domain_of:
- Schedule
range: DatedValue
multivalued: true
all_of:
- description: 'From Schedule. ValueExists: 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.'
any_of:
- slot_conditions:
value:
name: value
value_presence: PRESENT
- slot_conditions:
datedValue:
name: datedValue
value_presence: PRESENT