blob: ff8c857d6644eb8c88d43955c40b03f7761c7614 [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.Boolean - 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">Boolean</span>
<!-- if oneOf is set, then type is ignored -->
<span class="type">object</span>
</h2>
<div class="static-markdown"><p>A boolean parameter, with possible values being <code>true</code> or <code>false</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.Boolean</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">
<div><span class="type Xof">oneOf</span> [</div>
<div class="items-oneOf">
array
</div>
<div class="items-oneOf">
boolean
</div>
<div>]</div>
</td>
<td class="col-md-4">
<div><p>The current domain (possible values) of this <a class="schema_link" href="../Parameters/Boolean_schema.html" title="Parameters.Boolean">Parameters.Boolean</a>.</p>
<p>By default this is set to both <code>TRUE</code> and <code>FALSE</code>, meaning that the value of this <a class="schema_link" href="../Parameters/Boolean_schema.html" title="Parameters.Boolean">Parameters.Boolean</a> is
in an unknown state, and can be set to either <code>TRUE</code> or <code>FALSE</code> directly (by writing a single value to the parameter) or indirectly (through a constraint that requires a particular value).</p></div>
<div>
<!-- Can be one of following objects -->
<div class="item-type">
<!-- type is an array -->
<span class="type"><span class="Xof">oneOf</span> array</span>
</div>
<div class="item-type">
<!-- Other types -->
<span>
<span class="type Xof">oneOf</span>
<ul class="inline list-type">
<li class="inline type">boolean</li>
</ul>
</span>
</div>
</div>
<h5>Examples</h5>
<div>
<pre class="schema-json"><code class="language-json">true</code></pre>
<pre class="schema-json"><code class="language-json">false</code></pre>
<pre class="schema-json"><code class="language-json">[
false
]</code></pre>
<pre class="schema-json"><code class="language-json">[
true,
false
]</code></pre>
</div>
<div>
<b>Default</b>
<pre class="schema-json"><code class="language-json">[
true,
false
]</code></pre>
</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.Boolean&#34;,
&#34;name&#34;: &#34;FEAT_A&#34;,
&#34;constraints&#34;: [
{
&#34;_type&#34;: &#34;AST.BinaryOp&#34;,
&#34;left&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;FEAT_A&#34;
},
&#34;op&#34;: &#34;==&gt;&#34;,
&#34;right&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;FEAT_B&#34;
}
}
]
}</code></pre>
<pre class="schema-json"><code class="language-json">{
&#34;_type&#34;: &#34;Parameters.Boolean&#34;,
&#34;name&#34;: &#34;FEAT_B&#34;,
&#34;values&#34;: [
true
]
}</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.Boolean",
"name": "FEAT_A",
"constraints": [
{
"_type": "AST.BinaryOp",
"left": {
"_type": "AST.Identifier",
"value": "FEAT_A"
},
"op": "==>",
"right": {
"_type": "AST.Identifier",
"value": "FEAT_B"
}
}
]
},
{
"_type": "Parameters.Boolean",
"name": "FEAT_B",
"values": [
true
]
}
],
"info": [
"A boolean parameter, with possible values being `true` or `false`."
],
"properties": {
"_meta": {
"$ref": "../Meta.json"
},
"_type": {
"enum": [
"Parameters.Boolean"
]
},
"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": {
"info": [
"The current domain (possible values) of this $(Parameters.Boolean).",
[
"By default this is set to both `TRUE` and `FALSE`, meaning that the value of this $(Parameters.Boolean) is",
"in an unknown state, and can be set to either `TRUE` or `FALSE` directly (by writing a single value to the parameter) or indirectly (through a constraint that requires a particular value)."
]
],
"oneOf": [
{
"type": "array",
"items": {
"type": "boolean"
}
},
{
"type": "boolean"
}
],
"examples": [
true,
false,
[
false
],
[
true,
false
]
],
"default": [
true,
false
]
}
},
"required": [
"name"
],
"title": "Parameters.Boolean",
"$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>