blob: f2aca1292d9375304bfd32072c420b82203fe257 [file] [log] [blame]
<!-- 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>Parameters.Group - 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-namespace">Parameters.</span><span class=" title-type">Group</span>
<!-- if oneOf is set, then type is ignored -->
<span class="type">object</span>
</h2>
<div class="static-markdown"><p>The <a class="schema_link" href="../Parameters/Group_schema.html" title="Parameters.Group">Parameters.Group</a> is a way to namespace parameters, for example: <code>FEAT.X</code>, or <code>FEAT.X.Y</code>.</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>
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>Parameters.Group</code>
</dd>
</dl>
</td>
</tr>
<tr id="/properties/configured_by" class="property">
<th class="col-md-4">
<a href="#/properties/configured_by">configured_by</a>
</th>
<td class="col-md-4">
<a href="ParameterAbstract_schema.html#/definitions/configured_by" class="schema_link">ParameterAbstract</a>
</td>
<td class="col-md-4">
<div>
See
<a href="ParameterAbstract_schema.html#/definitions/configured_by" class="schema_link">definitions.configured_by</a> in
<a href="ParameterAbstract_schema.html#/definitions/configured_by" class="schema_link">ParameterAbstract</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/constraints" class="property">
<th class="col-md-4">
<a href="#/properties/constraints">constraints</a>
</th>
<td class="col-md-4">
<a href="ParameterAbstract_schema.html#/definitions/constraints" class="schema_link">ParameterAbstract</a>
</td>
<td class="col-md-4">
<div>
See
<a href="ParameterAbstract_schema.html#/definitions/constraints" class="schema_link">definitions.constraints</a> in
<a href="ParameterAbstract_schema.html#/definitions/constraints" class="schema_link">ParameterAbstract</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/description" class="property">
<th class="col-md-4">
<a href="#/properties/description">description</a>
</th>
<td class="col-md-4">
<a href="ParameterAbstract_schema.html#/definitions/description" class="schema_link">ParameterAbstract</a>
</td>
<td class="col-md-4">
<div>
See
<a href="ParameterAbstract_schema.html#/definitions/description" class="schema_link">definitions.description</a> in
<a href="ParameterAbstract_schema.html#/definitions/description" class="schema_link">ParameterAbstract</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/name" class="property">
<th class="col-md-4">
<a href="#/properties/name">name<sup>&loz;</sup></a>
</th>
<td class="col-md-4">
<a href="ParameterAbstract_schema.html#/definitions/name" class="schema_link">ParameterAbstract</a>
</td>
<td class="col-md-4">
<div>
See
<a href="ParameterAbstract_schema.html#/definitions/name" class="schema_link">definitions.name</a> in
<a href="ParameterAbstract_schema.html#/definitions/name" class="schema_link">ParameterAbstract</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/title" class="property">
<th class="col-md-4">
<a href="#/properties/title">title</a>
</th>
<td class="col-md-4">
<a href="ParameterAbstract_schema.html#/definitions/title" class="schema_link">ParameterAbstract</a>
</td>
<td class="col-md-4">
<div>
See
<a href="ParameterAbstract_schema.html#/definitions/title" class="schema_link">definitions.title</a> in
<a href="ParameterAbstract_schema.html#/definitions/title" class="schema_link">ParameterAbstract</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/values" class="property">
<th class="col-md-4">
<a href="#/properties/values">values</a>
</th>
<td class="col-md-4">
<a href="../Parameterset_schema.html" class="schema_link">Parameterset</a>
</td>
<td class="col-md-4">
<div>
See
<a href="../Parameterset_schema.html" class="schema_link">Parameterset</a>
for more information.
</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;Parameters.Group&#34;,
&#34;name&#34;: &#34;FEAT&#34;,
&#34;values&#34;: [
{
&#34;_type&#34;: &#34;Parameters.Boolean&#34;,
&#34;name&#34;: &#34;X&#34;
}
]
}</code></pre>
<pre class="schema-json"><code class="language-json">{
&#34;_type&#34;: &#34;Parameters.Group&#34;,
&#34;name&#34;: &#34;FEAT&#34;,
&#34;values&#34;: [
{
&#34;_type&#34;: &#34;Parameters.Group&#34;,
&#34;name&#34;: &#34;X&#34;,
&#34;values&#34;: [
{
&#34;_type&#34;: &#34;Parameters.Boolean&#34;,
&#34;name&#34;: &#34;Y&#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": "Parameters.Group",
"name": "FEAT",
"values": [
{
"_type": "Parameters.Boolean",
"name": "X"
}
]
},
{
"_type": "Parameters.Group",
"name": "FEAT",
"values": [
{
"_type": "Parameters.Group",
"name": "X",
"values": [
{
"_type": "Parameters.Boolean",
"name": "Y"
}
]
}
]
}
],
"info": [
"The $(Parameters.Group) is a way to namespace parameters, for example: `FEAT.X`, or `FEAT.X.Y`."
],
"properties": {
"_meta": {
"$ref": "../Meta.json"
},
"_type": {
"enum": [
"Parameters.Group"
]
},
"name": {
"$ref": "ParameterAbstract.json#/definitions/name"
},
"title": {
"$ref": "ParameterAbstract.json#/definitions/title"
},
"description": {
"$ref": "ParameterAbstract.json#/definitions/description"
},
"constraints": {
"$ref": "ParameterAbstract.json#/definitions/constraints"
},
"configured_by": {
"$ref": "ParameterAbstract.json#/definitions/configured_by"
},
"values": {
"$ref": "../Parameterset.json"
}
},
"required": [
"name"
],
"title": "Parameters.Group",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object"
}</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>