AARCHMRS Schema 2.5.3

↚ Home

Types.Field object

The Types.Field schema provides a mechanism to reference a field in a register. If you wish to refer to an entire Register, you should instead use Types.RegisterType.

object

Properties Type Description
_meta Meta

Metadata

See Meta for more information.
_type
Enum
Types.Field
value
  • object

This follows the same principle as a Types.RegisterType with the addition of the field property which defines the name of the field being referenced.

Examples
{
    "state": "AArch64", 
    "name": "REG0", 
    "field": "F1"
}
{
    "state": "AArch32", 
    "name": "REG0", 
    "field": "F1", 
    "rangeset": "5:4", 
    "instance": "REG0_S"
}
Additional Properties
Not Allowed
◊ Required
Properties marked with ◊ are required properties.
Examples
{
    "_type": "Types.Field", 
    "value": {
        "state": "AArch64", 
        "name": "REG0", 
        "field": "F1"
    }
}
{
    "_type": "Types.Field", 
    "value": {
        "state": "AArch32", 
        "name": "REG0", 
        "field": "F1", 
        "rangeset": "5:4", 
        "instance": "REG0_S"
    }
}

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

{
  "title": "Types.Field",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "info": [
    [
      "The $(Types.Field) schema provides a mechanism to reference a field in a register.",
      "If you wish to refer to an entire Register, you should instead use $(Types.RegisterType)."
    ]
  ],
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "_meta": {
      "$ref": "../Meta.json",
      "info": [
        "Metadata"
      ]
    },
    "_type": {
      "enum": [
        "Types.Field"
      ]
    },
    "value": {
      "info": [
        [
          "This follows the same principle as a $(Types.RegisterType) with the ",
          "addition of the `field` property which defines the name of the field",
          "being referenced."
        ]
      ],
      "type": "object",
      "properties": {
        "state": {
          "$ref": "RegisterType.json#/definitions/state"
        },
        "name": {
          "$ref": "RegisterType.json#/definitions/name"
        },
        "field": {
          "type": "string"
        },
        "slices": {
          "oneOf": [
            {
              "$ref": "../Rangeset.json"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "state",
        "name",
        "field"
      ],
      "examples": [
        {
          "state": "AArch64",
          "name": "REG0",
          "field": "F1"
        },
        {
          "state": "AArch32",
          "name": "REG0",
          "field": "F1",
          "rangeset": "5:4",
          "instance": "REG0_S"
        }
      ]
    }
  },
  "required": [
    "value"
  ],
  "examples": [
    {
      "_type": "Types.Field",
      "value": {
        "state": "AArch64",
        "name": "REG0",
        "field": "F1"
      }
    },
    {
      "_type": "Types.Field",
      "value": {
        "state": "AArch32",
        "name": "REG0",
        "field": "F1",
        "rangeset": "5:4",
        "instance": "REG0_S"
      }
    }
  ]
}