epics/gitea-pages
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
cee4bdef9839d2b1903776ad8c7f8f0c4e49d3cf
gitea-pages/software/CSDataQuick/docs/qcsdata.html
T
ebner cee4bdef98 first commit
2025-07-08 08:18:09 +02:00

403 lines
30 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- csdata.cpp -->
<title>QCSData 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>QCSData</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="qcsdata.html#public-types">Public Types</a></li>
<li class="level1"><a href="qcsdata.html#properties">Properties</a></li>
<li class="level1"><a href="qcsdata.html#public-functions">Public Functions</a></li>
<li class="level1"><a href="qcsdata.html#signals">Signals</a></li>
<li class="level1"><a href="qcsdata.html#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<div class="context">
<h1 class="title">QCSData Class</h1>
<!-- $$$QCSData-brief -->
<p>This class represents control system data. <a href="qcsdata.html#details">More...</a></p>
<!-- @@@QCSData -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;QCSData&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-csdataquick-data-csdata.html">CSData</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="http://doc.qt.io/qt-5/qobject.html">QObject</a></td></tr></table></div><ul>
<li><a href="qcsdata-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#AccessFlag-enum">AccessFlag</a></b> { NoAccess, ReadAccess, WriteAccess }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#AccessFlag-enum">AccessFlags</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#FieldType-enum">FieldType</a></b> { Invalid, String, Enum, Char, ..., Double }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qcsdata.html#accessRight-prop">accessRight</a></b> : const int</li>
<li class="fn"><b><a href="qcsdata.html#alarm-prop">alarm</a></b> : QCSDataAlarm * const</li>
<li class="fn"><b><a href="qcsdata.html#connected-prop">connected</a></b> : const bool</li>
<li class="fn"><b><a href="qcsdata.html#count-prop">count</a></b> : const qulonglong</li>
<li class="fn"><b><a href="qcsdata.html#extraProperties-prop">extraProperties</a></b> : QVariantMap</li>
<li class="fn"><b><a href="qcsdata.html#fieldType-prop">fieldType</a></b> : const FieldType</li>
<li class="fn"><b><a href="qcsdata.html#host-prop">host</a></b> : const QString</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qcsdata.html#precision-prop">precision</a></b> : const int</li>
<li class="fn"><b><a href="qcsdata.html#range-prop">range</a></b> : QCSDataRange * const</li>
<li class="fn"><b><a href="qcsdata.html#source-prop">source</a></b> : QString</li>
<li class="fn"><b><a href="qcsdata.html#stateStrings-prop">stateStrings</a></b> : const QStringList</li>
<li class="fn"><b><a href="qcsdata.html#timeStamp-prop">timeStamp</a></b> : const QDateTime</li>
<li class="fn"><b><a href="qcsdata.html#units-prop">units</a></b> : const QString</li>
<li class="fn"><b><a href="qcsdata.html#value-prop">value</a></b> : const QVariant</li>
</ul>
</td></tr>
</table></div>
<ul>
<li class="fn">1 property inherited from <a href="http://doc.qt.io/qt-5/qobject.html#properties">QObject</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="qcsdata.html#QCSData">QCSData</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#dtor.QCSData">~QCSData</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#accessRight-prop">accessRight</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCSDataAlarm *</td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#alarm-prop">alarm</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#connected-prop">connected</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qulonglong </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#count-prop">count</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariantMap </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#extraProperties-prop">extraProperties</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#extraProperty">extraProperty</a></b>(const QString <i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> FieldType </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#fieldType-prop">fieldType</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#host-prop">host</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#precision-prop">precision</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCSDataRange *</td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#range-prop">range</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#extraProperties-prop">setExtraProperties</a></b>(const QVariantMap <i>properties</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#source-prop">setSource</a></b>(const QString <i>source</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#source-prop">source</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#stateStrings-prop">stateStrings</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDateTime </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#timeStamp-prop">timeStamp</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#units-prop">units</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#value-prop">value</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">32 public functions inherited from <a href="http://doc.qt.io/qt-5/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#accessRight-prop">accessRightChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#alarm-prop">alarmChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#connected-prop">connectionChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#count-prop">countChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#fieldType-prop">fieldTypeChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#host-prop">hostChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#precision-prop">precisionChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#range-prop">rangeChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#source-prop">sourceChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#stateStrings-prop">stateStringsChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#timeStamp-prop">timeStampChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#units-prop">unitsChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdata.html#value-prop">valueChanged</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">2 signals inherited from <a href="http://doc.qt.io/qt-5/qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<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 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>
<!-- $$$QCSData-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>This class represents control system data.</p>
<p>The class is modeled after the EPICS process variable for control system data, which normally is a scalar or array value with describing meta data. In this class these are all represented as properties.</p>
<p>It is the <a href="qcsdata.html#source-prop">source</a> property that connects it to the control system, i.e&#x2e; data engines. The data engine manages the conntions to the control system, populates the data properties.</p>
</div>
<p><b>See also </b><a href="qcsdataengine.html">QCSDataEngine</a>.</p>
<!-- @@@QCSData -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$AccessFlag$$$NoAccess$$$ReadAccess$$$WriteAccess -->
<h3 class="flags" id="AccessFlag-enum"><a name="AccessFlag-enum"></a>enum QCSData::<span class="name">AccessFlag</span><br/>flags QCSData::<span class="name">AccessFlags</span></h3>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QCSData::NoAccess</code></td><td class="topAlign tblval"><code>0x00</code></td><td class="topAlign">No access to the data.</td></tr>
<tr><td class="topAlign"><code>QCSData::ReadAccess</code></td><td class="topAlign tblval"><code>0x01</code></td><td class="topAlign">Right to read.</td></tr>
<tr><td class="topAlign"><code>QCSData::WriteAccess</code></td><td class="topAlign tblval"><code>0x02</code></td><td class="topAlign">Right to write.</td></tr>
</table></div>
<p>The AccessFlags type is a typedef for <a href="http://doc.qt.io/qt-5/qflags.html">QFlags</a>&lt;AccessFlag&gt;. It stores an OR combination of AccessFlag values.</p>
<!-- @@@AccessFlag -->
<!-- $$$FieldType$$$Invalid$$$String$$$Enum$$$Char$$$Short$$$Integer$$$Long$$$Float$$$Double -->
<h3 class="fn" id="FieldType-enum"><a name="FieldType-enum"></a>enum QCSData::<span class="name">FieldType</span></h3>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QCSData::Invalid</code></td><td class="topAlign tblval"><code>-1</code></td><td class="topAlign">Invalid or disconnected data object</td></tr>
<tr><td class="topAlign"><code>QCSData::String</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">String of 8bit charactors.</td></tr>
<tr><td class="topAlign"><code>QCSData::Enum</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">An enumeration of choices</td></tr>
<tr><td class="topAlign"><code>QCSData::Char</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">8 bit char</td></tr>
<tr><td class="topAlign"><code>QCSData::Short</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">16 bit integer number</td></tr>
<tr><td class="topAlign"><code>QCSData::Integer</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">32 bit integer number</td></tr>
<tr><td class="topAlign"><code>QCSData::Long</code></td><td class="topAlign tblval"><code>5</code></td><td class="topAlign">64 bit integer number</td></tr>
<tr><td class="topAlign"><code>QCSData::Float</code></td><td class="topAlign tblval"><code>6</code></td><td class="topAlign">32 bit float number</td></tr>
<tr><td class="topAlign"><code>QCSData::Double</code></td><td class="topAlign tblval"><code>7</code></td><td class="topAlign">64 but float number</td></tr>
</table></div>
<!-- @@@FieldType -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$accessRight-prop$$$accessRight$$$accessRightChanged -->
<h3 class="fn" id="accessRight-prop"><a name="accessRight-prop"></a><span class="name">accessRight</span> : const <span class="type">int</span></h3>
<p>This property holds the access right of the data.</p>
<p>This is a bitwise or of <a href="qcsdata.html#AccessFlag-enum">QCSData::AccessFlag</a>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>accessRight</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>accessRightChanged</b></span>()</td></tr>
</table></div>
<!-- @@@accessRight -->
<!-- $$$alarm-prop$$$alarm$$$alarmChanged -->
<h3 class="fn" id="alarm-prop"><a name="alarm-prop"></a><span class="name">alarm</span> : <span class="type"><a href="qcsdataalarm.html">QCSDataAlarm</a></span> * const</h3>
<p>This property holds the alarm information.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QCSDataAlarm *</td><td class="memItemRight bottomAlign"><span class="name"><b>alarm</b></span>()</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>alarmChanged</b></span>()</td></tr>
</table></div>
<!-- @@@alarm -->
<!-- $$$connected-prop$$$connected$$$connectionChanged -->
<h3 class="fn" id="connected-prop"><a name="connected-prop"></a><span class="name">connected</span> : const <span class="type">bool</span></h3>
<p>This property indicates wether the data is connected to a valid source.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>connected</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>connectionChanged</b></span>()</td></tr>
</table></div>
<!-- @@@connected -->
<!-- $$$count-prop$$$count$$$countChanged -->
<h3 class="fn" id="count-prop"><a name="count-prop"></a><span class="name">count</span> : const <span class="type"><a href="http://doc.qt.io/qt-5/qtglobal.html#qulonglong-typedef">qulonglong</a></span></h3>
<p>This property holds the number of elements of the data.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> qulonglong </td><td class="memItemRight bottomAlign"><span class="name"><b>count</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>countChanged</b></span>()</td></tr>
</table></div>
<!-- @@@count -->
<!-- $$$extraProperties-prop$$$extraProperties$$$setExtraPropertiesconstQVariantMap -->
<h3 class="fn" id="extraProperties-prop"><a name="extraProperties-prop"></a><span class="name">extraProperties</span> : <span class="type"><a href="http://doc.qt.io/qt-5/qvariant.html#QVariantMap-typedef">QVariantMap</a></span></h3>
<p>This property holds any other properties specific to this instance.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QVariantMap </td><td class="memItemRight bottomAlign"><span class="name"><b>extraProperties</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setExtraProperties</b></span>(const QVariantMap <i>properties</i>)</td></tr>
</table></div>
<!-- @@@extraProperties -->
<!-- $$$fieldType-prop$$$fieldType$$$fieldTypeChanged -->
<h3 class="fn" id="fieldType-prop"><a name="fieldType-prop"></a><span class="name">fieldType</span> : const <span class="type"><a href="qcsdata.html#FieldType-enum">FieldType</a></span></h3>
<p>This property holds native type of the data.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> FieldType </td><td class="memItemRight bottomAlign"><span class="name"><b>fieldType</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>fieldTypeChanged</b></span>()</td></tr>
</table></div>
<!-- @@@fieldType -->
<!-- $$$host-prop$$$host$$$hostChanged -->
<h3 class="fn" id="host-prop"><a name="host-prop"></a><span class="name">host</span> : const <span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span></h3>
<p>This property holds the host name where the data source exists.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>host</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>hostChanged</b></span>()</td></tr>
</table></div>
<!-- @@@host -->
<!-- $$$precision-prop$$$precision$$$precisionChanged -->
<h3 class="fn" id="precision-prop"><a name="precision-prop"></a><span class="name">precision</span> : const <span class="type">int</span></h3>
<p>Precision of the data in case of float or double type.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>precision</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>precisionChanged</b></span>()</td></tr>
</table></div>
<!-- @@@precision -->
<!-- $$$range-prop$$$range$$$rangeChanged -->
<h3 class="fn" id="range-prop"><a name="range-prop"></a><span class="name">range</span> : <span class="type"><a href="qcsdatarange.html">QCSDataRange</a></span> * const</h3>
<p>This property holds the limits information.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QCSDataRange *</td><td class="memItemRight bottomAlign"><span class="name"><b>range</b></span>()</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>rangeChanged</b></span>()</td></tr>
</table></div>
<p><b>See also </b><a href="qcsdatarange.html">QCSDataRange</a>.</p>
<!-- @@@range -->
<!-- $$$source-prop$$$source$$$setSourceconstQString$$$sourceChanged -->
<h3 class="fn" id="source-prop"><a name="source-prop"></a><span class="name">source</span> : <span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span></h3>
<p>This property holds the data's source name.</p>
<p>The source name is of form &quot;[engine://]data_id&quot;. <i>engine://</i> selects the data engine where this data comes. If it is omitted, the default data engine is selected, which is EPICS channel access engine. <i>data_id</i> is the unique id to the data inside the selected data engine.</p>
<p>&quot;ca://my_pv&quot; or simply &quot;my_pv&quot; both specify the data comes from process variable <i>my_pv</i>.</p>
<p><b>Note: </b>If empty source name is assigned, the data will be be disconnected from the data engine if connected, and reset to its initial state.</p><p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>source</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSource</b></span>(const QString <i>source</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>sourceChanged</b></span>()</td></tr>
</table></div>
<!-- @@@source -->
<!-- $$$stateStrings-prop$$$stateStrings$$$stateStringsChanged -->
<h3 class="fn" id="stateStrings-prop"><a name="stateStrings-prop"></a><span class="name">stateStrings</span> : const <span class="type"><a href="http://doc.qt.io/qt-5/qstringlist.html">QStringList</a></span></h3>
<p>This property holds the string representation of data's enumerated states.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QStringList </td><td class="memItemRight bottomAlign"><span class="name"><b>stateStrings</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>stateStringsChanged</b></span>()</td></tr>
</table></div>
<!-- @@@stateStrings -->
<!-- $$$timeStamp-prop$$$timeStamp$$$timeStampChanged -->
<h3 class="fn" id="timeStamp-prop"><a name="timeStamp-prop"></a><span class="name">timeStamp</span> : const <span class="type"><a href="http://doc.qt.io/qt-5/qdatetime.html">QDateTime</a></span></h3>
<p>This property holds the timestamp of data's last change.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QDateTime </td><td class="memItemRight bottomAlign"><span class="name"><b>timeStamp</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>timeStampChanged</b></span>()</td></tr>
</table></div>
<!-- @@@timeStamp -->
<!-- $$$units-prop$$$units$$$unitsChanged -->
<h3 class="fn" id="units-prop"><a name="units-prop"></a><span class="name">units</span> : const <span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span></h3>
<p>This property holds the physical meaning of the data.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>units</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>unitsChanged</b></span>()</td></tr>
</table></div>
<!-- @@@units -->
<!-- $$$value-prop$$$value$$$valueChanged -->
<h3 class="fn" id="value-prop"><a name="value-prop"></a><span class="name">value</span> : const <span class="type"><a href="http://doc.qt.io/qt-5/qvariant.html">QVariant</a></span></h3>
<p>This property holds the value of the data.</p>
<p>The value can of scalar, array type or anything that the underlying data engine provides.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QVariant </td><td class="memItemRight bottomAlign"><span class="name"><b>value</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>valueChanged</b></span>()</td></tr>
</table></div>
<!-- @@@value -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCSData[overload1]$$$QCSDataQObject* -->
<h3 class="fn" id="QCSData"><a name="QCSData"></a>QCSData::<span class="name">QCSData</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>Construct a data object with the given <i>parent</i>.</p>
<!-- @@@QCSData -->
<!-- $$$~QCSData[overload1]$$$~QCSData -->
<h3 class="fn" id="dtor.QCSData"><a name="dtor.QCSData"></a>QCSData::<span class="name">~QCSData</span>()</h3>
<p>Delete the data object and disconnect from data engine.</p>
<!-- @@@~QCSData -->
<!-- $$$extraProperty[overload1]$$$extraPropertyconstQString -->
<h3 class="fn" id="extraProperty"><a name="extraProperty"></a><span class="type"><a href="http://doc.qt.io/qt-5/qvariant.html">QVariant</a></span> QCSData::<span class="name">extraProperty</span>(const <span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span> <i>name</i>)</h3>
<p>Gets a specific extra property <i>name</i>.</p>
<p><b>See also </b><a href="qcsdata.html#extraProperties-prop">QCSData::extraProperties</a>.</p>
<!-- @@@extraProperty -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">Copyright (C) 2012-2021 Xiaoqiang Wang, Paul Scherrer Institute.</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink