175 lines
12 KiB
HTML
175 lines
12 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<!-- csdataenginelocal.cpp -->
|
|
<title>QCSDataEngineLocal Class | CSDataQuick Documentation 1.2</title>
|
|
<link rel="stylesheet" type="text/css" href="style/online.css" />
|
|
<script type="text/javascript">
|
|
(function (i, s, o, g, r, a, m) {
|
|
i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
|
|
(i[r].q = i[r].q || []).push(arguments)
|
|
}, i[r].l = 1 * new Date(); a = s.createElement(o),
|
|
m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
|
|
})(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
|
|
|
|
ga('create', 'UA-24645639-4', 'qt.io');
|
|
ga('set', 'forceSSL', true);
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div class="header" id="header">
|
|
<header id="navbar" class="">
|
|
</header>
|
|
</div>
|
|
<div class="main">
|
|
<div class="main-rounded">
|
|
<div class="navigationbar">
|
|
<ul class="sub-navigation">
|
|
<li><a href="../../CSDataQuick.html">Home</a></li>
|
|
<li><a href="../docs.html" class="active">Documentation</a></li>
|
|
<li><a href="http://github.com/xiaoqiangwang/CSDataQuick/">Code</a></li>
|
|
<li><a href="https://github.com/xiaoqiangwang/CSDataQuick/issues/">Bug Reports</a></li>
|
|
</ul>
|
|
<div id="main_title_bar">
|
|
<h1>CSDataQuick Documentation</h1>
|
|
<div class="search_bar">
|
|
<script>
|
|
(function() {
|
|
var cx = '001693341472456439948:u9v0snkru3q';
|
|
var gcse = document.createElement('script');
|
|
gcse.type = 'text/javascript';
|
|
gcse.async = true;
|
|
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + '//www.google.com/cse/cse.js?cx=' + cx;
|
|
var s = document.getElementsByTagName('script')[0];
|
|
s.parentNode.insertBefore(gcse, s);
|
|
})();
|
|
</script>
|
|
<gcse:searchbox-only resultsUrl="search-results.html"></gcse:searchbox-only>
|
|
</div></div>
|
|
<ul>
|
|
<li><a href="index.html">CSDataQuick Documentation</a></li>
|
|
<li><a href="csdataquick-cpp.html">C++ Classes</a></li>
|
|
<li>QCSDataEngineLocal</li>
|
|
</ul>
|
|
</div>
|
|
<div class="content">
|
|
<div class="line">
|
|
<div class="content mainContent">
|
|
<div class="sidebar">
|
|
<div class="toc">
|
|
<h3><a name="toc">Contents</a></h3>
|
|
<ul>
|
|
<li class="level1"><a href="qcsdataenginelocal.html#public-functions">Public Functions</a></li>
|
|
<li class="level1"><a href="qcsdataenginelocal.html#reimplemented-public-functions">Reimplemented Public Functions</a></li>
|
|
<li class="level1"><a href="qcsdataenginelocal.html#details">Detailed Description</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sidebar-content" id="sidebar-content"></div></div>
|
|
<div class="context">
|
|
<h1 class="title">QCSDataEngineLocal Class</h1>
|
|
<!-- $$$QCSDataEngineLocal-brief -->
|
|
<p>User configurable data. <a href="qcsdataenginelocal.html#details">More...</a></p>
|
|
<!-- @@@QCSDataEngineLocal -->
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QCSDataEngineLocal></span>
|
|
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qcsdataengine.html">QCSDataEngine</a></td></tr></table></div><ul>
|
|
<li><a href="qcsdataenginelocal-members.html">List of all members, including inherited members</a></li>
|
|
</ul>
|
|
<a name="public-functions"></a>
|
|
<h2 id="public-functions">Public Functions</h2>
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcsdataenginelocal.html#QCSDataEngineLocal">QCSDataEngineLocal</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qcsdataenginelocal.html#dtor.QCSDataEngineLocal">~QCSDataEngineLocal</a></b>()</td></tr>
|
|
</table></div>
|
|
<a name="reimplemented-public-functions"></a>
|
|
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft rightAlign topAlign"> virtual ObjectModel *</td><td class="memItemRight bottomAlign"><b><a href="qcsdataenginelocal.html#allData">allData</a></b>()</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qcsdataenginelocal.html#close">close</a></b>(QCSData *<i>data</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qcsdataenginelocal.html#create">create</a></b>(QCSData *<i>data</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qcsdataenginelocal.html#description">description</a></b>()</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qcsdataenginelocal.html#name">name</a></b>()</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qcsdataenginelocal.html#setValue">setValue</a></b>(QCSData *<i>data</i>, const QVariant <i>value</i>)</td></tr>
|
|
</table></div>
|
|
<ul>
|
|
<li class="fn">6 public functions inherited from <a href="qcsdataengine.html#public-functions">QCSDataEngine</a></li>
|
|
<li class="fn">32 public functions inherited from <a href="http://doc.qt.io/qt-5/qobject.html#public-functions">QObject</a></li>
|
|
</ul>
|
|
<h3>Additional Inherited Members</h3>
|
|
<ul>
|
|
<li class="fn">3 properties inherited from <a href="qcsdataengine.html#properties">QCSDataEngine</a></li>
|
|
<li class="fn">1 property inherited from <a href="http://doc.qt.io/qt-5/qobject.html#properties">QObject</a></li>
|
|
<li class="fn">1 public slot inherited from <a href="http://doc.qt.io/qt-5/qobject.html#public-slots">QObject</a></li>
|
|
<li class="fn">1 signal inherited from <a href="qcsdataengine.html#signals">QCSDataEngine</a></li>
|
|
<li class="fn">2 signals inherited from <a href="http://doc.qt.io/qt-5/qobject.html#signals">QObject</a></li>
|
|
<li class="fn">1 public variable inherited from <a href="http://doc.qt.io/qt-5/qobject.html#public-variables">QObject</a></li>
|
|
<li class="fn">10 static public members inherited from <a href="http://doc.qt.io/qt-5/qobject.html#static-public-members">QObject</a></li>
|
|
<li class="fn">9 protected functions inherited from <a href="http://doc.qt.io/qt-5/qobject.html#protected-functions">QObject</a></li>
|
|
<li class="fn">2 protected variables inherited from <a href="http://doc.qt.io/qt-5/qobject.html#protected-variables">QObject</a></li>
|
|
</ul>
|
|
<a name="details"></a>
|
|
<!-- $$$QCSDataEngineLocal-description -->
|
|
<div class="descr">
|
|
<h2 id="details">Detailed Description</h2>
|
|
<p>User configurable data.</p>
|
|
<p>This data engine source has the form <i>loc://<name>[.{"field":"value"}]</i>. The trailing part after <i>.</i> is a JSON string. It could be used to configure the data and has the following fields:</p>
|
|
<div class="table"><table class="generic">
|
|
<thead><tr class="qt-style"><th >Field</th><th >Description</th></tr></thead>
|
|
<tr valign="top" class="odd"><td >type</td><td >Data type. Any of <i>enum</i>, <i>string</i>, <i>int</i> and <i>double</i>.</td></tr>
|
|
<tr valign="top" class="even"><td >value</td><td >Initial value.</td></tr>
|
|
<tr valign="top" class="odd"><td >enums</td><td >Array of state strings for <i>enum</i> type.</td></tr>
|
|
<tr valign="top" class="even"><td >precision</td><td >Precision of a <i>double</i> typed value.</td></tr>
|
|
</table></div>
|
|
<p>The data is not signaled as connected until it gets configured. If already configured, the second configurtion takes no effect.</p>
|
|
<pre class="cpp">loc:<span class="comment">//real.{"type": "double", "value": 3.14, "precision": 2}</span>
|
|
loc:<span class="comment">//integer.{"type": "int", "value": 3}</span>
|
|
loc:<span class="comment">//string.{"type": "string", "value": "string message"}</span>
|
|
loc:<span class="comment">//enum.{"type": "enum", "enums": ["off", "on"], "value": 1}</span></pre>
|
|
</div>
|
|
<!-- @@@QCSDataEngineLocal -->
|
|
<div class="func">
|
|
<h2>Member Function Documentation</h2>
|
|
<!-- $$$QCSDataEngineLocal[overload1]$$$QCSDataEngineLocalQObject* -->
|
|
<h3 class="fn" id="QCSDataEngineLocal"><a name="QCSDataEngineLocal"></a>QCSDataEngineLocal::<span class="name">QCSDataEngineLocal</span>(<span class="type"><a href="http://doc.qt.io/qt-5/qobject.html#QObject">QObject</a></span> *<i>parent</i> = Q_NULLPTR)</h3>
|
|
<p>Default constructs an instance of QCSDataEngineLocal.</p><!-- @@@QCSDataEngineLocal -->
|
|
<!-- $$$~QCSDataEngineLocal[overload1]$$$~QCSDataEngineLocal -->
|
|
<h3 class="fn" id="dtor.QCSDataEngineLocal"><a name="dtor.QCSDataEngineLocal"></a><code>[virtual] </code>QCSDataEngineLocal::<span class="name">~QCSDataEngineLocal</span>()</h3>
|
|
<p>Destroys the instance of QCSDataEngineLocal. The destructor is virtual.</p><!-- @@@~QCSDataEngineLocal -->
|
|
<!-- $$$allData[overload1]$$$allData -->
|
|
<h3 class="fn" id="allData"><a name="allData"></a><code>[virtual] </code><span class="type">ObjectModel</span> *QCSDataEngineLocal::<span class="name">allData</span>()</h3>
|
|
<p>Reimplemented from <a href="qcsdataengine.html#allData-prop">QCSDataEngine::allData</a>().</p>
|
|
<!-- @@@allData -->
|
|
<!-- $$$close[overload1]$$$closeQCSData* -->
|
|
<h3 class="fn" id="close"><a name="close"></a><code>[virtual] </code><span class="type">void</span> QCSDataEngineLocal::<span class="name">close</span>(<span class="type"><a href="qcsdata.html">QCSData</a></span> *<i>data</i>)</h3>
|
|
<p>Reimplemented from <a href="qcsdataengine.html#close">QCSDataEngine::close</a>().</p>
|
|
<!-- @@@close -->
|
|
<!-- $$$create[overload1]$$$createQCSData* -->
|
|
<h3 class="fn" id="create"><a name="create"></a><code>[virtual] </code><span class="type">void</span> QCSDataEngineLocal::<span class="name">create</span>(<span class="type"><a href="qcsdata.html">QCSData</a></span> *<i>data</i>)</h3>
|
|
<p>Reimplemented from <a href="qcsdataengine.html#create">QCSDataEngine::create</a>().</p>
|
|
<!-- @@@create -->
|
|
<!-- $$$description[overload1]$$$description -->
|
|
<h3 class="fn" id="description"><a name="description"></a><code>[virtual] </code><span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span> QCSDataEngineLocal::<span class="name">description</span>()</h3>
|
|
<p>Reimplemented from <a href="qcsdataengine.html#description-prop">QCSDataEngine::description</a>().</p>
|
|
<!-- @@@description -->
|
|
<!-- $$$name[overload1]$$$name -->
|
|
<h3 class="fn" id="name"><a name="name"></a><code>[virtual] </code><span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span> QCSDataEngineLocal::<span class="name">name</span>()</h3>
|
|
<p>Reimplemented from <a href="qcsdataengine.html#name-prop">QCSDataEngine::name</a>().</p>
|
|
<p>Returns the source scheme <i>loc</i>.</p>
|
|
<!-- @@@name -->
|
|
<!-- $$$setValue[overload1]$$$setValueQCSData*constQVariant -->
|
|
<h3 class="fn" id="setValue"><a name="setValue"></a><code>[virtual] </code><span class="type">void</span> QCSDataEngineLocal::<span class="name">setValue</span>(<span class="type"><a href="qcsdata.html">QCSData</a></span> *<i>data</i>, const <span class="type"><a href="http://doc.qt.io/qt-5/qvariant.html">QVariant</a></span> <i>value</i>)</h3>
|
|
<p>Reimplemented from <a href="qcsdataengine.html#setValue">QCSDataEngine::setValue</a>().</p>
|
|
<!-- @@@setValue -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">Copyright (C) 2012-2021 Xiaoqiang Wang, Paul Scherrer Institute.</div>
|
|
</body>
|
|
</html>
|