docs/StructureReference_schema.html - pub/scm/linux/kernel/git/maz/AARCHMRS - Git at Google

 <!-- Copyright (c) 2010-2025 Arm Limited or its affiliates. All rights reserved. -->
 <!-- This document is Non-confidential and licensed under the BSD 3-clause license. -->
 <!DOCTYPE html>
 <html>
 <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta http-equiv="x-ua-compatible" content="ie=edge">

     <!--FAVICON.ico-->
     <meta name="msapplication-TileColor" content="#2b5797">
     <meta name="msapplication-TileImage" content="./img/mstile-144x144.png">
     <link rel="icon" href="./img/favicon.ico">

         <title>StructureReference - ARM Machine Readable Schema - 2.7.1</title>

     <!--CSS-->
     <link rel="stylesheet" type="text/css" href="./css/bootstrap.min.css">
     <link rel="stylesheet" type="text/css" href="./css/schema.css">
     <link rel="stylesheet" type="text/css" href="./css/hljs-github.css">
 </head>
 <body>
     <div class="container">
         <div class="row heading">
             <div class="col-md-6 pull-left"><a href="./index.html"><img src="./img/arm.svg" class="logo" /></a></div>
             <div class="col-md-6 pull-left"><h1>AARCHMRS Schema <small>2.7.1</small></h1></div>

                 <!--Show the home button-->
                 <a href="./index.html"><div class="back-to-home">&nlarr; Home</div></a>
         </div>
     </div>

     <div class="container">


 <div class="row">


         <h2>
                 <span class=" title-type">StructureReference</span>

             <!-- if oneOf is set, then type is ignored -->
                 <span class="type">object</span>
         </h2>


     <div class="static-markdown"><p>The StructureReference class references a Structure object
 by holding the name of the referenced Structure.</p></div>
 </div>


 <div class="row">

     <div>
             <!-- A simple object -->
                 <h3 class="type">object</h3>

     <table class="table table-hover properties">
         <thead>
             <tr>
                 <th class="col-md-4">Properties</th>
                 <th class="col-md-4">Type</th>
                 <th class="col-md-4">Description</th>
             </tr>
         </thead>
         <tbody>

             <!-- properties -->


         <tr id="/properties/_meta" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/_meta">_meta</a>
             </th>
             <td class="col-md-4">
                     <a href="Meta_schema.html" class="schema_link">Meta</a>
             </td>
             <td class="col-md-4">
                     <div><p>User defined content.</p></div>

     <div>
         See
             <a href="Meta_schema.html" class="schema_link">Meta</a>
         for more information.
     </div>


             </td>
         </tr>

         <tr id="/properties/_type" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/_type">_type</a>
             </th>
             <td class="col-md-4">
             </td>
             <td class="col-md-4">
                     <dl>
                         <dt>Enum</dt>
                         <dd>
                             <code>StructureReference</code>
                         </dd>
                     </dl>


             </td>
         </tr>

         <tr id="/properties/condition" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/condition">condition</a>
             </th>
             <td class="col-md-4">
                     <a href="Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">Traits.HasCondition</a>
             </td>
             <td class="col-md-4">
                     <div><p>The condition must be true for this StructureReference to be present.</p>
 <p>Conditions are unique when <code>StructureReference</code> are used
 inside an array container, this is because two field layouts with the same
 condition cannot coexist.</p></div>

     <div>
         See
             <a href="Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">definitions.condition</a> in
             <a href="Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">Traits.HasCondition</a>
         for more information.
     </div>


             </td>
         </tr>

         <tr id="/properties/reference" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/reference">reference<sup>&loz;</sup></a>
             </th>
             <td class="col-md-4">
                         <ul class="inline list-type">
                                 <li class="inline type">string</li>
                         </ul>
             </td>
             <td class="col-md-4">
                     <div><p>The name of the Structure object being referenced.</p></div>


             </td>
         </tr>


             <!-- patternProperties -->

             <!-- object property attributes -->
             <tr>
                 <td colspan="3">
                     <dl>
                         <dt>Additional Properties</dt>
                         <dd>Not Allowed</dd>
                     </dl>
                 </td>
             </tr>

                 <tr>
                     <td colspan="3">
                         <dl>
                             <dt>&loz; Required</dt>
                             <dd>Properties marked with &loz; are required properties.</dd>
                         </dl>
                     </td>
                 </tr>
         </tbody>
     </table>


             <!-- array, and it has described items -->
     </div>


         <h5>Examples</h5>
         <div>
             <pre class="schema-json"><code class="language-json">{
     &#34;_type&#34;: &#34;StructureReference&#34;,
     &#34;reference&#34;: &#34;STE&#34;
 }</code></pre>
         </div>


 </div>

 <div class="row schema">
         <h3>Schema <small><a href="http://json-schema.org/draft-04/schema#">http://json-schema.org/draft-04/schema#</a></small></h3>
     <pre class="schema-json"><code class="language-json">{
   "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#"
 }</code></pre>
 </div>

     </div>

     <div class="container">
         <div class="footer text-right">
             Copyright &copy; 2025 ARM Limited or its affiliates. All rights reserved.
         </div>
     </div>

     <script src="./js/highlight/highlight.js"></script>
     <script src="./js/highlight/languages/json.min.js"></script>
     <script src="./js/highlight/languages/django.min.js"></script> <!-- JINJA2 -->
     <script src="./js/highlight/languages/yaml.min.js"></script>
     <script src="./js/highlight/languages/isa.js"></script>
     <script type="text/javascript">
         window.onload = function() {
             hljs.configure({
               cssSelector: ".schema-json code, .includes code, pre code",
               noHighlightRe: /^(no-?highlight|nohl)$/i,
             });
             hljs.highlightAll()
         };
     </script>

 </body>
 </html>
	<!-- Copyright (c) 2010-2025 Arm Limited or its affiliates. All rights reserved. -->
	<!-- This document is Non-confidential and licensed under the BSD 3-clause license. -->
	<!DOCTYPE html>
	<html>
	<head>
	<meta charset="utf-8" />
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<meta http-equiv="x-ua-compatible" content="ie=edge">

	<!--FAVICON.ico-->
	<meta name="msapplication-TileColor" content="#2b5797">
	<meta name="msapplication-TileImage" content="./img/mstile-144x144.png">
	<link rel="icon" href="./img/favicon.ico">

	<title>StructureReference - ARM Machine Readable Schema - 2.7.1</title>

	<!--CSS-->
	<link rel="stylesheet" type="text/css" href="./css/bootstrap.min.css">
	<link rel="stylesheet" type="text/css" href="./css/schema.css">
	<link rel="stylesheet" type="text/css" href="./css/hljs-github.css">
	</head>
	<body>
	<div class="container">
	<div class="row heading">
	<div class="col-md-6 pull-left"><a href="./index.html"><img src="./img/arm.svg" class="logo" /></a></div>
	<div class="col-md-6 pull-left"><h1>AARCHMRS Schema <small>2.7.1</small></h1></div>

	<!--Show the home button-->
	<a href="./index.html"><div class="back-to-home">&nlarr; Home</div></a>
	</div>
	</div>

	<div class="container">



















	<div class="row">




	<h2>
	<span class=" title-type">StructureReference</span>

	<!-- if oneOf is set, then type is ignored -->
	<span class="type">object</span>
	</h2>




	<div class="static-markdown"><p>The StructureReference class references a Structure object
	by holding the name of the referenced Structure.</p></div>
	</div>






	<div class="row">

	<div>
	<!-- A simple object -->
	<h3 class="type">object</h3>

	<table class="table table-hover properties">
	<thead>
	<tr>
	<th class="col-md-4">Properties</th>
	<th class="col-md-4">Type</th>
	<th class="col-md-4">Description</th>
	</tr>
	</thead>
	<tbody>

	<!-- properties -->


	<tr id="/properties/_meta" class="property">
	<th class="col-md-4">
	<a href="#/properties/_meta">_meta</a>
	</th>
	<td class="col-md-4">
	<a href="Meta_schema.html" class="schema_link">Meta</a>
	</td>
	<td class="col-md-4">
	<div><p>User defined content.</p></div>

	<div>
	See
	<a href="Meta_schema.html" class="schema_link">Meta</a>
	for more information.
	</div>




	</td>
	</tr>

	<tr id="/properties/_type" class="property">
	<th class="col-md-4">
	<a href="#/properties/_type">_type</a>
	</th>
	<td class="col-md-4">
	</td>
	<td class="col-md-4">
	<dl>
	<dt>Enum</dt>
	<dd>
	<code>StructureReference</code>
	</dd>
	</dl>



	</td>
	</tr>

	<tr id="/properties/condition" class="property">
	<th class="col-md-4">
	<a href="#/properties/condition">condition</a>
	</th>
	<td class="col-md-4">
	<a href="Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">Traits.HasCondition</a>
	</td>
	<td class="col-md-4">
	<div><p>The condition must be true for this StructureReference to be present.</p>
	<p>Conditions are unique when <code>StructureReference</code> are used
	inside an array container, this is because two field layouts with the same
	condition cannot coexist.</p></div>

	<div>
	See
	<a href="Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">definitions.condition</a> in
	<a href="Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">Traits.HasCondition</a>
	for more information.
	</div>




	</td>
	</tr>

	<tr id="/properties/reference" class="property">
	<th class="col-md-4">
	<a href="#/properties/reference">reference<sup>&loz;</sup></a>
	</th>
	<td class="col-md-4">
	<ul class="inline list-type">
	<li class="inline type">string</li>
	</ul>
	</td>
	<td class="col-md-4">
	<div><p>The name of the Structure object being referenced.</p></div>



	</td>
	</tr>


	<!-- patternProperties -->

	<!-- object property attributes -->
	<tr>
	<td colspan="3">
	<dl>
	<dt>Additional Properties</dt>
	<dd>Not Allowed</dd>
	</dl>
	</td>
	</tr>

	<tr>
	<td colspan="3">
	<dl>
	<dt>&loz; Required</dt>
	<dd>Properties marked with &loz; are required properties.</dd>
	</dl>
	</td>
	</tr>
	</tbody>
	</table>




	<!-- array, and it has described items -->
	</div>


	<h5>Examples</h5>
	<div>
	<pre class="schema-json"><code class="language-json">{
	"_type": "StructureReference",
	"reference": "STE"
	}</code></pre>
	</div>




	</div>

	<div class="row schema">
	<h3>Schema <small><a href="http://json-schema.org/draft-04/schema#">http://json-schema.org/draft-04/schema#</a></small></h3>
	<pre class="schema-json"><code class="language-json">{
	"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#"
	}</code></pre>
	</div>

	</div>

	<div class="container">
	<div class="footer text-right">
	Copyright © 2025 ARM Limited or its affiliates. All rights reserved.
	</div>
	</div>

	<script src="./js/highlight/highlight.js"></script>
	<script src="./js/highlight/languages/json.min.js"></script>
	<script src="./js/highlight/languages/django.min.js"></script> <!-- JINJA2 -->
	<script src="./js/highlight/languages/yaml.min.js"></script>
	<script src="./js/highlight/languages/isa.js"></script>
	<script type="text/javascript">
	window.onload = function() {
	hljs.configure({
	cssSelector: ".schema-json code, .includes code, pre code",
	noHighlightRe: /^(no-?highlight\|nohl)$/i,
	});
	hljs.highlightAll()
	};
	</script>

	</body>
	</html>