Class: NonNegativeQuantity

Specifies a quantity as a non-negative number, which condition is enforced through a data rule that only applies to the extending class.

URI: common_domain_model:NonNegativeQuantity

 classDiagram
    class NonNegativeQuantity
    click NonNegativeQuantity href "../NonNegativeQuantity/"
      Quantity <|-- NonNegativeQuantity
        click Quantity href "../Quantity/"
      
      NonNegativeQuantity : datedValue
        
          
    
        
        
        NonNegativeQuantity --> "*" DatedValue : datedValue
        click DatedValue href "../DatedValue/"
    

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

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

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

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

        
      NonNegativeQuantity : value
        
      

Inheritance

• Schedule
  • MeasureBase
    • QuantitySchedule
      • Quantity
        • NonNegativeQuantity

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 NonNegativeNumber	For a non-negative quantity, the value attribute must be positive	Schedule
datedValue	* DatedValue	The schedule must be absent	Schedule

Expressions & Logic

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

used by	used in	type	used
ContingentTransfer	quantity	range	NonNegativeQuantity
PayoutTransferBase	quantity	range	NonNegativeQuantity
ScheduledTransfer	quantity	range	NonNegativeQuantity
TransferBase	quantity	range	NonNegativeQuantity
UnscheduledTransfer	quantity	range	NonNegativeQuantity

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: NonNegativeQuantity
description: Specifies a quantity as a non-negative number, which condition is enforced
  through a data rule that only applies to the extending class.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Quantity
slot_usage:
  value:
    name: value
    description: For a non-negative quantity, the value attribute must be positive.
    range: NonNegativeNumber
    required: 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

Induced

name: NonNegativeQuantity
description: Specifies a quantity as a non-negative number, which condition is enforced
  through a data rule that only applies to the extending class.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Quantity
slot_usage:
  value:
    name: value
    description: For a non-negative quantity, the value attribute must be positive.
    range: NonNegativeNumber
    required: true
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: NonNegativeQuantity
    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: NonNegativeQuantity
    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: NonNegativeQuantity
    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: NonNegativeQuantity
    domain_of:
    - MeasureBase
    range: UnitType
    required: true
  value:
    name: value
    description: For a non-negative quantity, the value attribute must be positive.
    from_schema: https://w3id.org/lmodel/common-domain-model
    owner: NonNegativeQuantity
    domain_of:
    - DatedValue
    - Schedule
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AccrualFactor
    - AdjustmentFactor
    - ClauseLibraryVariableSet
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    range: NonNegativeNumber
    required: true
  datedValue:
    name: datedValue
    description: The schedule must be absent.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: NonNegativeQuantity
    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