153 lines
12 KiB
HTML
153 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" />
|
|
<!-- csdataquick-qmlmodules.qdoc -->
|
|
<title>CSDataQuick QML Types | 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>CSDataQuick QML Types</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="csdataquick-qmlmodules.html#control-system-data">Control System Data</a></li>
|
|
<li class="level1"><a href="csdataquick-qmlmodules.html#visual-components">Visual Components</a></li>
|
|
<li class="level2"><a href="csdataquick-qmlmodules.html#base-types">Base Types</a></li>
|
|
<li class="level2"><a href="csdataquick-qmlmodules.html#graphics">Graphics</a></li>
|
|
<li class="level2"><a href="csdataquick-qmlmodules.html#monitors">Monitors</a></li>
|
|
<li class="level2"><a href="csdataquick-qmlmodules.html#controls">Controls</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sidebar-content" id="sidebar-content"></div></div>
|
|
<div class="context">
|
|
<h1 class="title">CSDataQuick QML Types</h1>
|
|
<span class="subtitle"></span>
|
|
<!-- $$$csdataquick-qmlmodules.html-description -->
|
|
<div class="descr"> <a name="details"></a>
|
|
<a name="control-system-data"></a>
|
|
<h2 id="control-system-data">Control System Data</h2>
|
|
<p><a href="csdataquick-cpp.html#csdata">CSData</a> is modeled after the Process Variable (PV) as implemented in EPICS control system. It comprises a set of attributes (e.g. value, units, limits) and is indentified by a unique name <a href="qml-csdataquick-data-csdata.html#source-prop">CSData::source</a>.</p>
|
|
<p><i>References to Process Variable, PV, Channel might still appear in the documents in place of <a href="csdataquick-cpp.html#csdata">CSData</a>.</i></p>
|
|
<pre class="cpp">import CSDataQuick<span class="operator">.</span>Data <span class="number">1.0</span></pre>
|
|
<div class="table"><table class="annotated">
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-data-csdata.html">CSData</a></p></td><td class="tblDescr"><p>Object that represents control system data</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-data-csdataalarm.html">CSDataAlarm</a></p></td><td class="tblDescr"><p>Object provides alarm information about the data</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-data-csdatarange.html">CSDataRange</a></p></td><td class="tblDescr"><p>This class provides limits information about the data</p></td></tr>
|
|
</table></div>
|
|
<a name="visual-components"></a>
|
|
<h2 id="visual-components">Visual Components</h2>
|
|
<pre class="cpp">import CSDataQuick<span class="operator">.</span>Components <span class="number">1.0</span></pre>
|
|
<p>Most components name, style, function inspired by <a href="http://www.aps.anl.gov/epics/EpicsDocumentation/ExtensionsManuals/MEDM/MEDM.html#MEDMObjects">MEDM objects</a>. Some document texts are literally copied and the designer item icons are converted from MEDM xpm data.</p>
|
|
<p class="centerAlign"><img src="images/components-demo.png" alt="" /></p><a name="base-types"></a>
|
|
<h3 >Base Types</h3>
|
|
<div class="table"><table class="annotated">
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-basewindow.html">BaseWindow</a></p></td><td class="tblDescr"><p>Base for all toplevel windows</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cscontrol.html">CSControl</a></p></td><td class="tblDescr"><p>Basic type to all controls</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csgraphics.html">CSGraphics</a></p></td><td class="tblDescr"><p>Basic type to all graphics shapes</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csmonitor.html">CSMonitor</a></p></td><td class="tblDescr"><p>Basic type to all monitors</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-baseitem.html">BaseItem</a></p></td><td class="tblDescr"><p>Base item which all visual items derive</p></td></tr>
|
|
</table></div>
|
|
<a name="graphics"></a>
|
|
<h3 >Graphics</h3>
|
|
<div class="table"><table class="annotated">
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csarc.html">CSArc</a></p></td><td class="tblDescr"><p>Display an arc curve</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cscomposite.html">CSComposite</a></p></td><td class="tblDescr"><p>Display grouped items or include external files</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csimage.html">CSImage</a></p></td><td class="tblDescr"><p>Show a static or dynamic image</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csoval.html">CSOval</a></p></td><td class="tblDescr"><p>Display a circle or ellipse</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cspolygon.html">CSPolygon</a></p></td><td class="tblDescr"><p>Display a polygon shape</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cspolyline.html">CSPolyline</a></p></td><td class="tblDescr"><p>Display a polyline</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csrect.html">CSRect</a></p></td><td class="tblDescr"><p>Display a rectangle</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cstext.html">CSText</a></p></td><td class="tblDescr"><p>Display a text label</p></td></tr>
|
|
</table></div>
|
|
<a name="monitors"></a>
|
|
<h3 >Monitors</h3>
|
|
<div class="table"><table class="annotated">
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cs2dsscan.html">CS2DSscan</a></p></td><td class="tblDescr"><p>Display 2D sscan</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csadimage.html">CSADImage</a></p></td><td class="tblDescr"><p>Display an image from areaDetector</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csbar.html">CSBar</a></p></td><td class="tblDescr"><p>Display a bar that expands or contracts when value changes</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csbyte.html">CSByte</a></p></td><td class="tblDescr"><p>Display bits of an unsigned integer</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cscartesianplot.html">CSCartesianPlot</a></p></td><td class="tblDescr"><p>Display XY Plot</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csindicator.html">CSIndicator</a></p></td><td class="tblDescr"><p>Indicator displays the value on a scale</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csmjpegvideo.html">CSMJPEGVideo</a></p></td><td class="tblDescr"><p>Display a video from MJPEG video stream</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csmeter.html">CSMeter</a></p></td><td class="tblDescr"><p>Displays the value on a cirular dial panel</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csstripchart.html">CSStripChart</a></p></td><td class="tblDescr"><p>Display a strip chart</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cstextupdate.html">CSTextUpdate</a></p></td><td class="tblDescr"><p>Display the value in given format</p></td></tr>
|
|
</table></div>
|
|
<a name="controls"></a>
|
|
<h3 >Controls</h3>
|
|
<div class="table"><table class="annotated">
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cschoicebutton.html">CSChoiceButton</a></p></td><td class="tblDescr"><p>Display data's enumerate</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csmenu.html">CSMenu</a></p></td><td class="tblDescr"><p>Displays process variable's enumerate in drop-down menu</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csmessagebutton.html">CSMessageButton</a></p></td><td class="tblDescr"><p>Displays a push button</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csrelateddisplay.html">CSRelatedDisplay</a></p></td><td class="tblDescr"><p>Brings up more displays</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csshellcommand.html">CSShellCommand</a></p></td><td class="tblDescr"><p>Run shell commands</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csslider.html">CSSlider</a></p></td><td class="tblDescr"><p>Display a slider to control a PV</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-csspinbox.html">CSSpinBox</a></p></td><td class="tblDescr"><p>Display a spin box control</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cstextarea.html">CSTextArea</a></p></td><td class="tblDescr"><p>Display an editable multiline text</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cstextentry.html">CSTextEntry</a></p></td><td class="tblDescr"><p>Display an editable text</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cstextentryarray.html">CSTextEntryArray</a></p></td><td class="tblDescr"><p>Display text entry for array data</p></td></tr>
|
|
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cstogglebutton.html">CSToggleButton</a></p></td><td class="tblDescr"><p>Displays a checkbox to toggle a boolean value</p></td></tr>
|
|
<tr class="even topAlign"><td class="tblName"><p><a href="qml-csdataquick-components-cswheelswitch.html">CSWheelSwitch</a></p></td><td class="tblDescr"><p>Control a number with individual digit manipulation</p></td></tr>
|
|
</table></div>
|
|
</div>
|
|
<!-- @@@csdataquick-qmlmodules.html -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">Copyright (C) 2012-2021 Xiaoqiang Wang, Paul Scherrer Institute.</div>
|
|
</body>
|
|
</html>
|