Class: Quantity

name: Quantity
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"CompareQuantityByUnitOfAmount","inputs":[{"name":"quantity1","type":"Quantity","cardinality":"0..*"},{"name":"op","type":"CompareOp","cardinality":"1..1"},{"name":"quantity2","type":"Quantity","cardinality":"0..*"},{"name":"unitOfAmount","type":"UnitType","cardinality":"1..1"}],"output":{"name":"result","type":"boolean","cardinality":"1..1"}},{"name":"FilterQuantity","description":"Filter
      list of quantities based on unit type.","inputs":[{"name":"quantities","type":"Quantity","cardinality":"0..*"},{"name":"unit","type":"UnitType","cardinality":"1..1"}],"output":{"name":"filteredQuantities","type":"Quantity","cardinality":"0..*"}}]'
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 amount value exists.
comments:
- 'Rosetta condition: AmountOnlyExists — value exists and datedValue is absent'
- 'Rosetta func: CompareQuantityByUnitOfAmount'
- 'Rosetta func: FilterQuantity — Filter list of quantities based on unit type.'
in_subset:
- cdm_base_math
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- gist:Magnitude
is_a: QuantitySchedule
rules:
- postconditions:
    slot_conditions:
      value:
        name: value
        required: true
      datedValue:
        name: datedValue
        required: false
  description: The amount must exist when the quantity represents a single value,
    and the steps must be absent.

name: Quantity
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"CompareQuantityByUnitOfAmount","inputs":[{"name":"quantity1","type":"Quantity","cardinality":"0..*"},{"name":"op","type":"CompareOp","cardinality":"1..1"},{"name":"quantity2","type":"Quantity","cardinality":"0..*"},{"name":"unitOfAmount","type":"UnitType","cardinality":"1..1"}],"output":{"name":"result","type":"boolean","cardinality":"1..1"}},{"name":"FilterQuantity","description":"Filter
      list of quantities based on unit type.","inputs":[{"name":"quantities","type":"Quantity","cardinality":"0..*"},{"name":"unit","type":"UnitType","cardinality":"1..1"}],"output":{"name":"filteredQuantities","type":"Quantity","cardinality":"0..*"}}]'
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 amount value exists.
comments:
- 'Rosetta condition: AmountOnlyExists — value exists and datedValue is absent'
- 'Rosetta func: CompareQuantityByUnitOfAmount'
- 'Rosetta func: FilterQuantity — Filter list of quantities based on unit type.'
in_subset:
- cdm_base_math
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- gist:Magnitude
is_a: QuantitySchedule
attributes:
  multiplier:
    name: multiplier
    description: Defines an optional number that the quantity should be multiplied
      by to derive a total quantity. This number is associated to a 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
    rank: 1000
    owner: Quantity
    domain_of:
    - QuantitySchedule
    - FloatingRateProcessingParameters
    range: Measure
  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
    rank: 1000
    owner: Quantity
    domain_of:
    - QuantitySchedule
    - CSAValuationDate
    range: Frequency
  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: Quantity
    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: Quantity
    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: Quantity
    domain_of:
    - MeasureBase
    - Qty
    - Term
    range: UnitType
rules:
- postconditions:
    slot_conditions:
      value:
        name: value
        required: true
      datedValue:
        name: datedValue
        required: false
  description: The amount must exist when the quantity represents a single value,
    and the steps must be absent.