AARCHMRS Schema 2.5.3

↚ Home

Values.Value object

A value object defines a bitstring. A meaning can be optionally defined to describe the context of this bitstring.

definition

Definitions Type Description
value
  • string
Pattern
/^(0(b[01x]+|x[0-9A-Fa-f]+)|'[01x]+')$/

object

Properties Type Description
_meta Meta
See Meta for more information.
_type
Enum
Values.Value
meaning Text

The meaning associated with this bitstring.

See Text for more information.
value
  • string

The bitstring representing the value.

This must be a string of bits (each bit of which may take values 0, 1 or x, this last indicating "could be either 0 or 1"), wrapped in single-quotes.

Pattern
/^'[01x]+'$/
Examples
"'10'"
"'1x'"
Additional Properties
Not Allowed
◊ Required
Properties marked with ◊ are required properties.
Examples
{
    "_type": "Values.Value", 
    "value": "'00001'", 
    "meaning": "The first defined value"
}

Schema http://json-schema.org/draft-04/schema#

{
  "definitions": {
    "value": {
      "pattern": "^(0(b[01x]+|x[0-9A-Fa-f]+)|'[01x]+')$",
      "type": "string"
    }
  },
  "info": [
    [
      "A value object defines a bitstring. A meaning can be optionally defined to",
      "describe the context of this bitstring."
    ]
  ],
  "properties": {
    "_meta": {
      "$ref": "../Meta.json"
    },
    "_type": {
      "enum": [
        "Values.Value"
      ]
    },
    "meaning": {
      "$ref": "../Text.json",
      "info": [
        "The meaning associated with this bitstring."
      ]
    },
    "value": {
      "info": [
        "The bitstring representing the value.",
        "This must be a string of bits (each bit of which may take values `0`, `1` or `x`, this last indicating \"could be either 0 or 1\"), wrapped in single-quotes."
      ],
      "type": "string",
      "pattern": "^'[01x]+'$",
      "examples": [
        "'10'",
        "'1x'"
      ]
    }
  },
  "required": [
    "value"
  ],
  "title": "Value",
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "additionalProperties": false,
  "examples": [
    {
      "_type": "Values.Value",
      "value": "'00001'",
      "meaning": "The first defined value"
    }
  ]
}