Skip to content
common-domain-model

Class: Quantity

Specifies a quantity as a single value to be associated to a financial product, for example a transfer amount resulting from a trade. This data type extends QuantitySchedule and requires that only the single value exists.

URI: common_domain_model:Quantity

 classDiagram
    class Quantity
    click Quantity href "../Quantity/"
      QuantitySchedule <|-- Quantity
        click QuantitySchedule href "../QuantitySchedule/"
      

      Quantity <|-- NonNegativeQuantity
        click NonNegativeQuantity href "../NonNegativeQuantity/"
      Quantity <|-- Money
        click Money href "../Money/"
      

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

        
      Quantity : frequency
        
          
    
        
        
        Quantity --> "0..1" Frequency : frequency
        click Frequency href "../Frequency/"
    

        
      Quantity : multiplier
        
          
    
        
        
        Quantity --> "0..1" NonNegativeMeasure : multiplier
        click NonNegativeMeasure href "../NonNegativeMeasure/"
    

        
      Quantity : total
        
          
    
        
        
        Quantity --> "0..1" Schedule : total
        click Schedule href "../Schedule/"
    

        
      Quantity : unit
        
          
    
        
        
        Quantity --> "1" UnitType : unit
        click UnitType href "../UnitType/"
    

        
      Quantity : value

Inheritance

Section titled “Inheritance”

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
multiplier 0..1
NonNegativeMeasure		 Defines an optional measure that the quantity should be multiplied by to deri… QuantitySchedule
frequency 0..1
Frequency		 Defines the frequency to be used when defining a quantity QuantitySchedule
total 0..1
Schedule		 Specifies the total quantity when the quantity itself is specified with a fre… QuantitySchedule
unit 1
UnitType		 Requires that a unit of amount must be specified for any quantity MeasureBase
value 1
Decimal		 Requires the single rate or amount, as the case may be, to be present Schedule
datedValue *
DatedValue		 The schedule must be absent Schedule
Expressions & Logic

All Of

Section titled “All Of”

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’)})} })] })

Usages

Section titled “Usages”
used by used in type used
CalculateTransferInstruction quantity range Quantity
ReturnInstruction quantity range Quantity
AvailableInventoryRecord quantity range Quantity
EventCurrency eventCurrentAmount range Quantity
Illiquidity minimumAmount range Quantity
SpecificInconvertibility minimumAmount range Quantity
AssetDeliveryInformation deliveryCapacity range Quantity
AssetDeliveryProfileBlock deliveryCapacity range Quantity
CalculationScheduleDeliveryPeriods deliveryCapacity range Quantity
ResolvablePriceQuantity resolvedQuantity range Quantity

Comments

Section titled “Comments”
  • Rosetta condition DatedValueIsAbsent is not stated in LinkML: datedValue is absent and total -> datedValue is absent

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self common_domain_model:Quantity
native common_domain_model:Quantity

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: Quantity
description: Specifies a quantity as a single value to be associated to a financial
  product, for example a transfer amount resulting from a trade. This data type extends
  QuantitySchedule and requires that only the single value exists.
comments:
- 'Rosetta condition DatedValueIsAbsent is not stated in LinkML: datedValue is absent
  and total -> datedValue is absent'
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: QuantitySchedule
slot_usage:
  value:
    name: value
    description: Requires the single rate or amount, as the case may be, to be present.
      An initial rate of 5% would be represented as 0.05.
    range: decimal
    required: true
  datedValue:
    name: datedValue
    description: The schedule must be absent.
    range: DatedValue
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

Induced

Section titled “Induced”
name: Quantity
description: Specifies a quantity as a single value to be associated to a financial
  product, for example a transfer amount resulting from a trade. This data type extends
  QuantitySchedule and requires that only the single value exists.
comments:
- 'Rosetta condition DatedValueIsAbsent is not stated in LinkML: datedValue is absent
  and total -> datedValue is absent'
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: QuantitySchedule
slot_usage:
  value:
    name: value
    description: Requires the single rate or amount, as the case may be, to be present.
      An initial rate of 5% would be represented as 0.05.
    range: decimal
    required: true
  datedValue:
    name: datedValue
    description: The schedule must be absent.
    range: DatedValue
attributes:
  multiplier:
    name: multiplier
    description: Defines an optional measure that the quantity should be multiplied
      by to derive a total quantity. Requires that the multiplier must be positive.
      This number is associated to an optional unit. For example in the case of the
      Coal (API2) CIF ARA (ARGUS-McCloskey) Futures Contract on the CME, where the
      unit would be contracts, the multiplier value would 1,000 and the mulitiplier
      unit would be 1,000 MT (Metric Tons).
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_math
    rank: 1000
    owner: Quantity
    domain_of:
    - QuantitySchedule
    - FloatingRateProcessingParameters
    range: NonNegativeMeasure
  frequency:
    name: frequency
    description: Defines the frequency to be used when defining a quantity. For example
      a quantity may be specified as a number of barrels of oil per day, which needs
      multiplying by the number of days in the relevant period to get the total quantity
      as a number of barrels.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_math
    rank: 1000
    owner: Quantity
    domain_of:
    - QuantitySchedule
    - CSAValuationDate
    range: Frequency
  total:
    name: total
    description: Specifies the total quantity when the quantity itself is specified
      with a frequency.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_math
    rank: 1000
    owner: Quantity
    domain_of:
    - QuantitySchedule
    range: Schedule
  unit:
    name: unit
    description: Requires that a unit of amount must be specified for any quantity.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: Quantity
    domain_of:
    - MeasureBase
    range: UnitType
    required: true
  value:
    name: value
    description: Requires the single rate or amount, as the case may be, to be present.
      An initial rate of 5% would be represented as 0.05.
    from_schema: https://w3id.org/lmodel/common-domain-model
    owner: Quantity
    domain_of:
    - DatedValue
    - Schedule
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AccrualFactor
    - AdjustmentFactor
    - ClauseLibraryVariableSet
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    range: decimal
    required: true
  datedValue:
    name: datedValue
    description: The schedule must be absent.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: Quantity
    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