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

190 lines
11 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>QCSDataAlarm 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>QCSDataAlarm</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="qcsdataalarm.html#public-types">Public Types</a></li>
<li class="level1"><a href="qcsdataalarm.html#properties">Properties</a></li>
<li class="level1"><a href="qcsdataalarm.html#public-functions">Public Functions</a></li>
<li class="level1"><a href="qcsdataalarm.html#signals">Signals</a></li>
<li class="level1"><a href="qcsdataalarm.html#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<div class="context">
<h1 class="title">QCSDataAlarm Class</h1>
<!-- $$$QCSDataAlarm-brief -->
<p>The <a href="qml-csdataquick-data-csdataalarm.html">CSDataAlarm</a> class provides alarm information about the data. <a href="qcsdataalarm.html#details">More...</a></p>
<!-- @@@QCSDataAlarm -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;QCSDataAlarm&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-csdataquick-data-csdataalarm.html">CSDataAlarm</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="qcsdataalarm-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="qcsdataalarm.html#Severity-enum">Severity</a></b> { NoAlarm, MinorAlarm, MajorAlarm, InvalidAlarm }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qcsdataalarm.html#message-prop">message</a></b> : const QString</li>
<li class="fn"><b><a href="qcsdataalarm.html#severity-prop">severity</a></b> : const Severity</li>
<li class="fn"><b><a href="qcsdataalarm.html#status-prop">status</a></b> : const int</li>
</ul>
<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="qcsdataalarm.html#QCSDataAlarm">QCSDataAlarm</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcsdataalarm.html#setAlarm">setAlarm</a></b>(Severity <i>severity</i>, int <i>status</i>, const QString <i>message</i>)</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="qcsdataalarm.html#alarmChanged">alarmChanged</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>
<!-- $$$QCSDataAlarm-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qml-csdataquick-data-csdataalarm.html">CSDataAlarm</a> class provides alarm information about the data.</p>
</div>
<!-- @@@QCSDataAlarm -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Severity$$$NoAlarm$$$MinorAlarm$$$MajorAlarm$$$InvalidAlarm -->
<h3 class="fn" id="Severity-enum"><a name="Severity-enum"></a>enum QCSDataAlarm::<span class="name">Severity</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>QCSDataAlarm::NoAlarm</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">Normal state</td></tr>
<tr><td class="topAlign"><code>QCSDataAlarm::MinorAlarm</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Lowest alarm severity</td></tr>
<tr><td class="topAlign"><code>QCSDataAlarm::MajorAlarm</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Highest alarm severity</td></tr>
<tr><td class="topAlign"><code>QCSDataAlarm::InvalidAlarm</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Invalid data or no communication.</td></tr>
</table></div>
<!-- @@@Severity -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$message-prop$$$alarmChanged -->
<h3 class="fn" id="message-prop"><a name="message-prop"></a><span class="name">message</span> : const <span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span></h3>
<p>This property holds the alarm message.</p>
<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><a href="qcsdataalarm.html#alarmChanged">alarmChanged</a></b></span>()</td></tr>
</table></div>
<!-- @@@message -->
<!-- $$$severity-prop$$$alarmChanged -->
<h3 class="fn" id="severity-prop"><a name="severity-prop"></a><span class="name">severity</span> : const <span class="type"><a href="qcsdataalarm.html#Severity-enum">Severity</a></span></h3>
<p>This property holds the alarm severity.</p>
<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><a href="qcsdataalarm.html#alarmChanged">alarmChanged</a></b></span>()</td></tr>
</table></div>
<p><b>See also </b><a href="qcsdataalarm.html#Severity-enum">QCSDataAlarm::Severity</a>.</p>
<!-- @@@severity -->
<!-- $$$status-prop$$$alarmChanged -->
<h3 class="fn" id="status-prop"><a name="status-prop"></a><span class="name">status</span> : const <span class="type">int</span></h3>
<p>This property holds the alarm status.</p>
<p>The actual meaning depends on data engine.</p>
<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><a href="qcsdataalarm.html#alarmChanged">alarmChanged</a></b></span>()</td></tr>
</table></div>
<!-- @@@status -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCSDataAlarm[overload1]$$$QCSDataAlarmQObject* -->
<h3 class="fn" id="QCSDataAlarm"><a name="QCSDataAlarm"></a>QCSDataAlarm::<span class="name">QCSDataAlarm</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 alarm information object with the given <i>parent</i>.</p>
<!-- @@@QCSDataAlarm -->
<!-- $$$setAlarm[overload1]$$$setAlarmSeverityintconstQString -->
<h3 class="fn" id="setAlarm"><a name="setAlarm"></a><span class="type">void</span> QCSDataAlarm::<span class="name">setAlarm</span>(<span class="type"><a href="qcsdataalarm.html#Severity-enum">Severity</a></span> <i>severity</i>, <span class="type">int</span> <i>status</i>, const <span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span> <i>message</i>)</h3>
<p>Set the alarm <i>severity</i>, <i>status</i> and <i>message</i>.</p>
<!-- @@@setAlarm -->
</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