Revision 5b94fd2c12712e04345d4b130358afbb352f6436 authored by vthierry on 28 October 2025, 18:54:37 UTC, committed by vthierry on 28 October 2025, 18:54:37 UTC
1 parent 4ad30c1
global.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Global - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<input type="text" id="nav-search" placeholder="Search" />
<h2><a href="index.html">Home</a></h2><h3>Objects</h3><ul><li><a href="FValue.html">FValue</a><ul class='members'></ul><ul class='methods'><li data-type='method' style='display: none;'><a href="FValue.html#set">set</a></li></ul></li><li><a href="LValue.html">LValue</a><ul class='members'></ul><ul class='methods'><li data-type='method' style='display: none;'><a href="LValue.html#getTurtoise">getTurtoise</a></li><li data-type='method' style='display: none;'><a href="LValue.html#setTurtoise">setTurtoise</a></li><li data-type='method' style='display: none;'><a href="LValue.html#deduce">deduce</a></li><li data-type='method' style='display: none;'><a href="LValue.html#.readTriples">readTriples</a></li></ul></li><li><a href="Value.html">Value</a><ul class='members'><li data-type='member' style='display: none;'><a href="Value.html#.EMPTY">EMPTY</a></li></ul><ul class='methods'><li data-type='method' style='display: none;'><a href="Value.html#asString">asString</a></li><li data-type='method' style='display: none;'><a href="Value.html#isEmpty">isEmpty</a></li><li data-type='method' style='display: none;'><a href="Value.html#isRecord">isRecord</a></li><li data-type='method' style='display: none;'><a href="Value.html#isArray">isArray</a></li><li data-type='method' style='display: none;'><a href="Value.html#isMember">isMember</a></li><li data-type='method' style='display: none;'><a href="Value.html#length">length</a></li><li data-type='method' style='display: none;'><a href="Value.html#count">count</a></li><li data-type='method' style='display: none;'><a href="Value.html#getNames">getNames</a></li><li data-type='method' style='display: none;'><a href="Value.html#size">size</a></li><li data-type='method' style='display: none;'><a href="Value.html#get">get</a></li><li data-type='method' style='display: none;'><a href="Value.html#at">at</a></li><li data-type='method' style='display: none;'><a href="Value.html#aget">aget</a></li><li data-type='method' style='display: none;'><a href="Value.html#set">set</a></li><li data-type='method' style='display: none;'><a href="Value.html#add">add</a></li><li data-type='method' style='display: none;'><a href="Value.html#copy">copy</a></li><li data-type='method' style='display: none;'><a href="Value.html#erase">erase</a></li><li data-type='method' style='display: none;'><a href="Value.html#rename">rename</a></li><li data-type='method' style='display: none;'><a href="Value.html#clear">clear</a></li><li data-type='method' style='display: none;'><a href="Value.html#sort">sort</a></li><li data-type='method' style='display: none;'><a href="Value.html#sortNames">sortNames</a></li><li data-type='method' style='display: none;'><a href="Value.html#equals">equals</a></li></ul></li><li><a href="WJSONReader.html">WJSONReader</a><ul class='members'></ul><ul class='methods'><li data-type='method' style='display: none;'><a href="WJSONReader.html#.read">read</a></li></ul></li><li><a href="WJSONWriter.html">WJSONWriter</a><ul class='members'></ul><ul class='methods'><li data-type='method' style='display: none;'><a href="WJSONWriter.html#.write">write</a></li></ul></li><li><a href="wJSON.html">wJSON</a><ul class='methods'><li data-type='method' style='display: none;'><a href="wJSON.html#.parse">parse</a></li><li data-type='method' style='display: none;'><a href="wJSON.html#.stringify">stringify</a></li><li data-type='method' style='display: none;'><a href="wJSON.html#.wjson2json">wjson2json</a></li><li data-type='method' style='display: none;'><a href="wJSON.html#.wjson2wjson">wjson2wjson</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#quote">quote</a></li><li><a href="global.html#string2json">string2json</a></li><li><a href="global.html#array2vector">array2vector</a></li><li><a href="global.html#run_protege">run_protege</a></li><li><a href="global.html#ttl2n3">ttl2n3</a></li><li><a href="global.html#wjson2html">wjson2html</a></li><li><a href="global.html#wjson2json">wjson2json</a></li><li><a href="global.html#wjson2wjson">wjson2wjson</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="quote"><span class="type-signature type-signature-static">(static) </span>quote<span class="signature">(word)</span><span class="type-signature"> → {string}</span></h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li><p>Returns a wjson string name or value with <code>"</code> quotes if required, to avoid syntax error.</p>
<ul>
<li>Called with the <code>wjson::quote(word)</code> construct.</li>
</ul></li></ul></dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>word</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The word to quote if required.</p></td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<div class="param-desc">
<p>Either the word itself or with quote, if appropriate.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="string2json"><span class="type-signature type-signature-static">(static) </span>string2json<span class="signature">(string, sort_names<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {JSON}</span></h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li><p>Static C/C++ string to JSON conversion for convenience.</p>
<pre class="prettyprint source"><code>// Typical usage is for constructor or method arguments of the form, e.g.:
… set(wjson::string2json(aidesys::echo("{do: grab device: %d}", device), …
</code></pre></li></ul></dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>string</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The initial value.</p></td>
</tr>
<tr>
<td class="name"><code>sort_names</code></td>
<td class="type">
<span class="param-type">bool</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>If true sorts the names in alphabetic order, as performed by sortNames()</p></td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<div class="param-desc">
<p>A temporary reference towards the best effort parsed value.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">JSON</span>
</dd>
</dl>
<h4 class="name" id="array2vector"><span class="type-signature type-signature-static">(static) </span>array2vector<span class="signature">(data, name<span class="signature-attributes">opt</span>, defaultValue<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array}</span></h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li><p>Converts a data structure to a numerical array.</p></li></ul></dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">JSON</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The data structure array of the form:</p>
<pre class="prettyprint source"><code>[
{ name: value … }
../..
]
</code></pre>
<p>or simply:</p>
<pre class="prettyprint source"><code>[
value
../..
]
</code></pre></td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>An optional field numerical value, if omitted the data structure is assumed to an numerical array.</p></td>
</tr>
<tr>
<td class="name"><code>defaultValue</code></td>
<td class="type">
<span class="param-type">double</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>NAN</code>
</td>
<td class="description last"><p>An optional default value if the expected value is missing.</p></td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<div class="param-desc">
<p>A temporary reference to a <code>std::vector<double></code> array with the related values.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id="run_protege"><span class="type-signature type-signature-static">(static) </span>run_protege<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li><p>Remote control of the Protégé GUI interface system.</p>
<ul>
<li>
<p>This allows to interface a <a href="./LValue.html">LValue</a> with a reasoner.</p>
</li>
<li>
<p>Only available as a command line application:</p>
</li>
</ul>
<pre class="prettyprint source"><code> Usage: ./src/run_protege.sh input.owl
Runs Protégé loading the ontology, running the default reasoner, and exporting the inferred axioms.
Generates an output file of name input.owl.inferred.owl in Turtle format.
Generates a log of all operations in /tmp/run_protege.log.
The Protege GUI must be manually parameterized before use, for instance defining the default reasoner.
Caution: do not manipulate the mouse or keyboard during the process, only one instance can run at a given time.
Disclaimer: this is only an experimental fragile setup, only available under Linux, valid only for Protege-5.5.0
(GUI parameters may have to be redefined for another Protégé version).
Requires: xdotool.
</code></pre></li></ul></dd>
</dl>
<h4 class="name" id="ttl2n3"><span class="type-signature type-signature-static">(static) </span>ttl2n3<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li><p>Converts a file from turtle to n-triples format</p>
<ul>
<li>Only available as a command line application:</li>
</ul>
<pre class="prettyprint source"><code> Usage: ./src/ttl2n3.js < input > output
</code></pre></li></ul></dd>
</dl>
<h4 class="name" id="wjson2html"><span class="type-signature type-signature-static">(static) </span>wjson2html<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li><p>Command line wrapper to reformat a strong or weak JSON syntax string to a normalized weak JSON format.</p>
<ul>
<li>Only available as a command line application, see also <a href="./wJSON.html">wJSON</a> object.</li>
</ul>
<pre class="prettyprint source"><code> Usage: ./src/wjson2html.js < json-file.json > json-file.html
</code></pre></li></ul></dd>
</dl>
<h4 class="name" id="wjson2json"><span class="type-signature type-signature-static">(static) </span>wjson2json<span class="signature">(Input)</span><span class="type-signature"> → {string}</span></h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li><p>Command line wrapper to reformats a weak JSON syntax string to a normalized standard JSON format.</p></li></ul></dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>string, in wjson or json format.</p></td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<div class="param-desc">
<p>Output string in pretty json format.</p>
<ul>
<li>Also available as a line command application (see also <a href="./wJSON.html">wJSON</a> object):</li>
</ul>
<pre class="prettyprint source"><code> Usage: ./src/wjson2json.js < wjson-file.json > json-file.json
</code></pre>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="wjson2wjson"><span class="type-signature type-signature-static">(static) </span>wjson2wjson<span class="signature">(Input)</span><span class="type-signature"> → {string}</span></h4>
<dl class="details">
<dt class="tag-description">Description:</dt>
<dd class="tag-description"><ul class="dummy"><li><p>Command line wrapper to reformat a strong or weak JSON syntax string to a normalized weak JSON format.</p></li></ul></dd>
</dl>
<h5 class="h5-parameters">Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>string, in wjson or json format.</p></td>
</tr>
</tbody>
</table>
<h5 class="h5-returns">Returns:</h5>
<div class="param-desc">
<p>Output string in pretty wjson format.</p>
<ul>
<li>Also available as a line command application, (see also <a href="./wJSON.html">wJSON</a> object):</li>
</ul>
<pre class="prettyprint source"><code> Usage: ./src/wjson2wjson.js < json-file.json > wjson-file.json
</code></pre>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</article>
</section>
</div>
<br class="clear">
<footer>
<div style='float: right;font-style: italic;'>2025-10-28 version.</div>
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/search.js" defer></script>
<script src="scripts/collapse.js" defer></script>
</body>
</html>
Computing file changes ...
