AARCHMRS Schema 2.7.4

↚ Home

StructureReference object

The StructureReference class references a Structure object by holding the name of the referenced Structure.

object

Properties Type Description
_meta Meta

User defined content.

See Meta for more information.
_type
Enum
StructureReference
condition Traits.HasCondition

The condition must be true for this StructureReference to be present.

Conditions are unique when StructureReference are used inside an array container, this is because two field layouts with the same condition cannot coexist.

See definitions.condition in Traits.HasCondition for more information.
reference
  • string

The name of the Structure object being referenced.

Additional Properties
Not Allowed
◊ Required
Properties marked with ◊ are required properties.
Examples
{
    "_type": "StructureReference", 
    "reference": "STE"
}

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

{
  "additionalProperties": false,
  "examples": [
    {
      "_type": "StructureReference",
      "reference": "STE"
    }
  ],
  "info": [
    [
      "The StructureReference class references a Structure object",
      "by holding the name of the referenced Structure."
    ]
  ],
  "properties": {
    "_meta": {
      "$ref": "Meta.json",
      "info": [
        "User defined content."
      ]
    },
    "_type": {
      "enum": [
        "StructureReference"
      ]
    },
    "reference": {
      "info": [
        "The name of the Structure object being referenced."
      ],
      "type": "string"
    },
    "condition": {
      "$ref": "Traits/HasCondition.json#/definitions/condition",
      "info": [
        "The condition must be true for this StructureReference to be present.",
        [
          "Conditions are unique when `StructureReference` are used",
          "inside an array container, this is because two field layouts with the same ",
          "condition cannot coexist."
        ]
      ]
    }
  },
  "required": [
    "reference"
  ],
  "title": "StructureReference",
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema#"
}