.cdm-java.6.0.0-dev.63.source-code.cdm-base-math-NonNegativeQuantity.schema.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdm-java Show documentation

There is a newer version: 6.0.0-dev.89

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$anchor": "cdm.base.math",
  "type": "object",
  "title": "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.",
  "properties": {
    "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).",
      "$ref": "cdm-base-math-Measure.schema.json"
    },
    "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.",
      "$ref": "cdm-base-datetime-Frequency.schema.json"
    },
    "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.",
      "type": "array",
      "items": {
        "$ref": "cdm-base-math-DatedValue.schema.json"
      },
      "minItems": 0
    },
    "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.",
      "type": "number"
    },
    "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).",
      "$ref": "cdm-base-math-UnitType.schema.json"
    }
  }
}