Class: NonNegativeQuantitySchedule

Specifies a quantity schedule where all the values must be non-negative.

URI: common_domain_model:NonNegativeQuantitySchedule

 classDiagram
    class NonNegativeQuantitySchedule
    click NonNegativeQuantitySchedule href "../NonNegativeQuantitySchedule/"
      QuantitySchedule <|-- NonNegativeQuantitySchedule
        click QuantitySchedule href "../QuantitySchedule/"
      
      NonNegativeQuantitySchedule : datedValue
        
          
    
        
        
        NonNegativeQuantitySchedule --> "*" NonNegativeDatedValue : datedValue
        click NonNegativeDatedValue href "../NonNegativeDatedValue/"
    

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

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

        
      NonNegativeQuantitySchedule : total
        
          
    
        
        
        NonNegativeQuantitySchedule --> "0..1" NonNegativeSchedule : total
        click NonNegativeSchedule href "../NonNegativeSchedule/"
    

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

        
      NonNegativeQuantitySchedule : value
        
      

Inheritance

• Schedule
  • MeasureBase
    • QuantitySchedule
      • NonNegativeQuantitySchedule

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 NonNegativeSchedule	For a non-negative quantity schedule, all amount attribute must be positive	QuantitySchedule
unit	1 UnitType	Requires that a unit of amount must be specified for any quantity	MeasureBase
value	0..1 NonNegativeNumber	For a non-negative quantity schedule, all amount attribute must be positive	Schedule
datedValue	* NonNegativeDatedValue	For a non-negative quantity schedule, all amount attribute must be positive	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
BasketConstituent	quantity	range	NonNegativeQuantitySchedule
Price	derivedQuantity	range	NonNegativeQuantitySchedule
PriceQuantity	quantity	range	NonNegativeQuantitySchedule
PriceSchedule	derivedQuantity	range	NonNegativeQuantitySchedule
FutureValueAmount	quantity	range	NonNegativeQuantitySchedule
VarianceReturnTerms	vegaNotionalAmount	range	NonNegativeQuantitySchedule
ResolvablePriceQuantity	quantitySchedule	range	NonNegativeQuantitySchedule
PortfolioReturnTerms	quantity	range	NonNegativeQuantitySchedule

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: NonNegativeQuantitySchedule
description: Specifies a quantity schedule where all the values must be non-negative.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: QuantitySchedule
slot_usage:
  value:
    name: value
    description: For a non-negative quantity schedule, all amount attribute must be
      positive.
    range: NonNegativeNumber
  datedValue:
    name: datedValue
    description: For a non-negative quantity schedule, all amount attribute must be
      positive.
    range: NonNegativeDatedValue
    multivalued: true
  total:
    name: total
    description: For a non-negative quantity schedule, all amount attribute must be
      positive.
    range: NonNegativeSchedule
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: NonNegativeQuantitySchedule
description: Specifies a quantity schedule where all the values must be non-negative.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: QuantitySchedule
slot_usage:
  value:
    name: value
    description: For a non-negative quantity schedule, all amount attribute must be
      positive.
    range: NonNegativeNumber
  datedValue:
    name: datedValue
    description: For a non-negative quantity schedule, all amount attribute must be
      positive.
    range: NonNegativeDatedValue
    multivalued: true
  total:
    name: total
    description: For a non-negative quantity schedule, all amount attribute must be
      positive.
    range: NonNegativeSchedule
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: NonNegativeQuantitySchedule
    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: NonNegativeQuantitySchedule
    domain_of:
    - QuantitySchedule
    - CSAValuationDate
    range: Frequency
  total:
    name: total
    description: For a non-negative quantity schedule, all amount attribute must be
      positive.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: NonNegativeQuantitySchedule
    domain_of:
    - QuantitySchedule
    range: NonNegativeSchedule
  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: NonNegativeQuantitySchedule
    domain_of:
    - MeasureBase
    range: UnitType
    required: true
  value:
    name: value
    description: For a non-negative quantity schedule, all amount attribute must be
      positive.
    from_schema: https://w3id.org/lmodel/common-domain-model
    owner: NonNegativeQuantitySchedule
    domain_of:
    - DatedValue
    - Schedule
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AccrualFactor
    - AdjustmentFactor
    - ClauseLibraryVariableSet
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    range: NonNegativeNumber
  datedValue:
    name: datedValue
    description: For a non-negative quantity schedule, all amount attribute must be
      positive.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: NonNegativeQuantitySchedule
    domain_of:
    - Schedule
    range: NonNegativeDatedValue
    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