Class: Frequency

A class for defining a date frequency, e.g. one day, three months, through the combination of an integer value and a standardized period value that is specified as part of an enumeration.

URI: common_domain_model:Frequency

 classDiagram
    class Frequency
    click Frequency href "../Frequency/"
      Frequency <|-- CalculationPeriodFrequency
        click CalculationPeriodFrequency href "../CalculationPeriodFrequency/"
      Frequency <|-- ResetFrequency
        click ResetFrequency href "../ResetFrequency/"
      
      Frequency : period
        
          
    
        
        
        Frequency --> "1" PeriodExtendedEnum : period
        click PeriodExtendedEnum href "../PeriodExtendedEnum/"
    

        
      Frequency : periodMultiplier
        
      

Inheritance

• Frequency
  • CalculationPeriodFrequency
  • ResetFrequency

Slots

Name	Cardinality and Range	Description	Inheritance
periodMultiplier	1 Integer	A time period multiplier, e	direct
period	1 PeriodExtendedEnum	A time period, e	direct

Expressions & Logic

All Of

The class must satisfy all of:

• AnonymousClassExpression({ ‘description’: (’PositivePeriodMultiplier: FpML specifies periodMultiplier as a positive ’ ‘integer.’), ‘slot_conditions’: {‘periodMultiplier’: SlotDefinition({‘name’: ‘periodMultiplier’, ‘minimum_value’: 1})} })

Usages

used by	used in	type	used
NonNegativeQuantity	frequency	range	Frequency
NonNegativeQuantitySchedule	frequency	range	Frequency
Quantity	frequency	range	Frequency
QuantitySchedule	frequency	range	Frequency
Money	frequency	range	Frequency
PaymentDates	paymentFrequency	range	Frequency

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	{'period': {'equals_string': 'T'}}	{'periodMultiplier': {'equals_number': 1}}

Identifier and Mapping Information

Annotations

property	value
rosetta_metadata	key

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Frequency
annotations:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: A class for defining a date frequency, e.g. one day, three months, through
  the combination of an integer value and a standardized period value that is specified
  as part of an enumeration.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  periodMultiplier:
    name: periodMultiplier
    description: A time period multiplier, e.g. 1, 2, or 3. If the period value is
      T (Term) then period multiplier must contain the value 1.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_datetime
    rank: 1000
    domain_of:
    - Frequency
    - Period
    - Velocity
    range: integer
    required: true
  period:
    name: period
    description: A time period, e.g. a day, week, month, year or term of the stream.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_datetime
    domain_of:
    - CalculationFrequency
    - Frequency
    - Period
    - PeriodBound
    - Velocity
    - AverageTradingVolume
    range: PeriodExtendedEnum
    required: true
rules:
- preconditions:
    slot_conditions:
      period:
        name: period
        equals_string: T
  postconditions:
    slot_conditions:
      periodMultiplier:
        name: periodMultiplier
        equals_number: 1
  description: 'TermPeriod: FpML specifies that if period value is T (Term) then periodMultiplier
    must contain the value 1.'
all_of:
- description: 'PositivePeriodMultiplier: FpML specifies periodMultiplier as a positive
    integer.'
  slot_conditions:
    periodMultiplier:
      name: periodMultiplier
      minimum_value: 1

Induced

name: Frequency
annotations:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: A class for defining a date frequency, e.g. one day, three months, through
  the combination of an integer value and a standardized period value that is specified
  as part of an enumeration.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  periodMultiplier:
    name: periodMultiplier
    description: A time period multiplier, e.g. 1, 2, or 3. If the period value is
      T (Term) then period multiplier must contain the value 1.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_datetime
    rank: 1000
    owner: Frequency
    domain_of:
    - Frequency
    - Period
    - Velocity
    range: integer
    required: true
  period:
    name: period
    description: A time period, e.g. a day, week, month, year or term of the stream.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_datetime
    owner: Frequency
    domain_of:
    - CalculationFrequency
    - Frequency
    - Period
    - PeriodBound
    - Velocity
    - AverageTradingVolume
    range: PeriodExtendedEnum
    required: true
rules:
- preconditions:
    slot_conditions:
      period:
        name: period
        equals_string: T
  postconditions:
    slot_conditions:
      periodMultiplier:
        name: periodMultiplier
        equals_number: 1
  description: 'TermPeriod: FpML specifies that if period value is T (Term) then periodMultiplier
    must contain the value 1.'
all_of:
- description: 'PositivePeriodMultiplier: FpML specifies periodMultiplier as a positive
    integer.'
  slot_conditions:
    periodMultiplier:
      name: periodMultiplier
      minimum_value: 1