Variable

PartDraftv1.0.0-rc.2

A variable: a named Value or formula that criteria and steps refer to, such as a framework's limit or a method's parameter.

https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Variable.json

Fields

id
textnot empty
The record's id: unique within the document.
nameRequired
text
The name people use for the record.
description
text
What the record is, in words.
citation
DatatypeCitation
The published work that states the amount or the formula.
value
DatatypeValue
The variable's amount, when it is fixed.
expression
DatatypeExpression
How the variable is worked out, when it is not fixed.

Exactly one of value or expression.

Links

Held by Records that embed this one, with their field that holds it.

Examples

An id that another example defines opens that record.

Example 2

{
  "id": "variable-night-psl",
  "name": "Night-time permissible sound level",
  "description": "The basic sound level plus the adjustments for the area.",
  "expression": {
    "operation": "add",
    "arguments": [
      {
        "variable": "variable-bsl"
      },
      {
        "variable": "variable-adjustments"
      }
    ]
  }
}

Show 1 more example

Example 1

{
  "id": "variable-1",
  "name": "Basic sound level",
  "value": {
    "amount": 40,
    "unit": "dB"
  }
}

Changes and file

Changes

0.1.0 First version.

Schema file

Show the JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Variable.json",
  "title": "Variable",
  "description": "A variable: a named Value or formula that criteria and steps refer to, such as a framework's limit or a method's parameter.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The record's id: unique within the document."
    },
    "name": {
      "type": "string",
      "description": "The name people use for the record."
    },
    "description": {
      "type": "string",
      "description": "What the record is, in words."
    },
    "citation": {
      "$ref": "Citation.json",
      "description": "The published work that states the amount or the formula."
    },
    "value": {
      "$ref": "Value.json",
      "description": "The variable's amount, when it is fixed."
    },
    "expression": {
      "$ref": "Expression.json",
      "description": "How the variable is worked out, when it is not fixed."
    }
  },
  "required": [
    "name"
  ],
  "oneOf": [
    {
      "properties": {
        "value": true
      },
      "required": [
        "value"
      ]
    },
    {
      "properties": {
        "expression": true
      },
      "required": [
        "expression"
      ]
    }
  ],
  "patternProperties": {
    "^x-": {}
  },
  "unevaluatedProperties": false,
  "examples": [
    {
      "id": "variable-1",
      "name": "Basic sound level",
      "value": {
        "amount": 40,
        "unit": "dB"
      }
    },
    {
      "id": "variable-night-psl",
      "name": "Night-time permissible sound level",
      "description": "The basic sound level plus the adjustments for the area.",
      "expression": {
        "operation": "add",
        "arguments": [
          {
            "variable": "variable-bsl"
          },
          {
            "variable": "variable-adjustments"
          }
        ]
      }
    }
  ],
  "x-ods-status": "draft",
  "x-ods-kind": "part",
  "x-ods-module": "core",
  "x-ods-changes": {
    "0.1.0": "First version."
  }
}