Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-updates > by-pkgid > 6ed78e842caa17fd5c94d65d685685e0 > files > 76

qtscxml5-doc-5.12.6-1.mga7.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qscxmlnulldatamodel.cpp -->
  <title>QScxmlNullDataModel Class | Qt SCXML 5.12.6</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.12</td><td ><a href="qtscxml-index.html">Qt SCXML</a></td><td ><a href="qtscxml-module.html">C++ Classes</a></td><td >QScxmlNullDataModel</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtscxml-index.html">Qt 5.12.6 Reference Documentation</a></td>
        </tr></table>
      </div>
    </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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QScxmlNullDataModel Class</h1>
<!-- $$$QScxmlNullDataModel-brief -->
<p>The <a href="qscxmlnulldatamodel.html">QScxmlNullDataModel</a> class is the null data model for a Qt SCXML <a href="qscxmldatamodel.html#stateMachine-prop">stateMachine</a>. <a href="#details">More...</a></p>
<!-- @@@QScxmlNullDataModel -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QScxmlNullDataModel&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += scxml</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qscxmldatamodel.html">QScxmlDataModel</a></td></tr></table></div><ul>
<li><a href="qscxmlnulldatamodel-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="qscxmlnulldatamodel.html#QScxmlNullDataModel">QScxmlNullDataModel</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#dtor.QScxmlNullDataModel">~QScxmlNullDataModel</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 void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#evaluateAssignment">evaluateAssignment</a></b>(QScxmlExecutableContent::EvaluatorId <i>id</i>, bool *<i>ok</i>) override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#evaluateForeach">evaluateForeach</a></b>(QScxmlExecutableContent::EvaluatorId <i>id</i>, bool *<i>ok</i>, QScxmlDataModel::ForeachLoopBody *<i>body</i>) override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#evaluateInitialization">evaluateInitialization</a></b>(QScxmlExecutableContent::EvaluatorId <i>id</i>, bool *<i>ok</i>) override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#evaluateToBool">evaluateToBool</a></b>(QScxmlExecutableContent::EvaluatorId <i>id</i>, bool *<i>ok</i>) override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#evaluateToString">evaluateToString</a></b>(QScxmlExecutableContent::EvaluatorId <i>id</i>, bool *<i>ok</i>) override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#evaluateToVariant">evaluateToVariant</a></b>(QScxmlExecutableContent::EvaluatorId <i>id</i>, bool *<i>ok</i>) override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#evaluateToVoid">evaluateToVoid</a></b>(QScxmlExecutableContent::EvaluatorId <i>id</i>, bool *<i>ok</i>) override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#hasScxmlProperty">hasScxmlProperty</a></b>(const QString &amp;<i>name</i>) const override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#scxmlProperty">scxmlProperty</a></b>(const QString &amp;<i>name</i>) const override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#setScxmlEvent">setScxmlEvent</a></b>(const QScxmlEvent &amp;<i>event</i>) override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#setScxmlProperty">setScxmlProperty</a></b>(const QString &amp;<i>name</i>, const QVariant &amp;<i>value</i>, const QString &amp;<i>context</i>) override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#setup">setup</a></b>(const QVariantMap &amp;<i>initialDataValues</i>) override</td></tr>
</table></div>
<ul>
<li class="fn">14 public functions inherited from <a href="qscxmldatamodel.html#public-functions">QScxmlDataModel</a></li>
</ul>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qscxmlnulldatamodel.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qscxmldatamodel.html#properties">QScxmlDataModel</a></li>
<li class="fn">1 signal inherited from <a href="qscxmldatamodel.html#signals">QScxmlDataModel</a></li>
</ul>
<a name="details"></a>
<!-- $$$QScxmlNullDataModel-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qscxmlnulldatamodel.html">QScxmlNullDataModel</a> class is the null data model for a Qt SCXML <a href="qscxmldatamodel.html#stateMachine-prop">stateMachine</a>.</p>
<p>This class implements the null data model as described in the <a href="https://www.w3.org/TR/scxml/#minimal-profile">SCXML Specification - B.1 The Null Data Model</a>. Using the value <code>&quot;null&quot;</code> for the <i>datamodel</i> attribute of the <code>&lt;scxml&gt;</code> element means that there is no underlying data model, but some executable content, like <code>In(..&#x2e;)</code> or <code>&lt;log&gt;</code> can still be used.</p>
</div>
<p><b>See also </b><a href="qscxmlstatemachine.html">QScxmlStateMachine</a> and <a href="qscxmldatamodel.html">QScxmlDataModel</a>.</p>
<!-- @@@QScxmlNullDataModel -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QScxmlNullDataModel[overload1]$$$QScxmlNullDataModelQObject* -->
<h3 class="fn" id="QScxmlNullDataModel"><a name="QScxmlNullDataModel"></a>QScxmlNullDataModel::<span class="name">QScxmlNullDataModel</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Creates a new Qt SCXML null data model, with the parent object <i>parent</i>.</p>
<!-- @@@QScxmlNullDataModel -->
<!-- $$$~QScxmlNullDataModel[overload1]$$$~QScxmlNullDataModel -->
<h3 class="fn" id="dtor.QScxmlNullDataModel"><a name="dtor.QScxmlNullDataModel"></a><code>[virtual] </code>QScxmlNullDataModel::<span class="name">~QScxmlNullDataModel</span>()</h3>
<p>Destroys the data model.</p>
<!-- @@@~QScxmlNullDataModel -->
<!-- $$$evaluateAssignment[overload1]$$$evaluateAssignmentQScxmlExecutableContent::EvaluatorIdbool* -->
<h3 class="fn" id="evaluateAssignment"><a name="evaluateAssignment"></a><code>[override virtual] </code><span class="type">void</span> QScxmlNullDataModel::<span class="name">evaluateAssignment</span>(<span class="type"><a href="qscxmlexecutablecontent.html#EvaluatorId-typedef">QScxmlExecutableContent::EvaluatorId</a></span> <i>id</i>, <span class="type">bool</span> *<i>ok</i>)</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#evaluateAssignment">QScxmlDataModel::evaluateAssignment</a>().</p>
<p>Throws an error and sets <i>ok</i> to <code>false</code>, because the null data model cannot evaluate assignments.</p>
<!-- @@@evaluateAssignment -->
<!-- $$$evaluateForeach[overload1]$$$evaluateForeachQScxmlExecutableContent::EvaluatorIdbool*QScxmlDataModel::ForeachLoopBody* -->
<h3 class="fn" id="evaluateForeach"><a name="evaluateForeach"></a><code>[override virtual] </code><span class="type">void</span> QScxmlNullDataModel::<span class="name">evaluateForeach</span>(<span class="type"><a href="qscxmlexecutablecontent.html#EvaluatorId-typedef">QScxmlExecutableContent::EvaluatorId</a></span> <i>id</i>, <span class="type">bool</span> *<i>ok</i>, <span class="type"><a href="qscxmldatamodel-foreachloopbody.html">QScxmlDataModel::ForeachLoopBody</a></span> *<i>body</i>)</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#evaluateForeach">QScxmlDataModel::evaluateForeach</a>().</p>
<p>Throws an error and sets <i>ok</i> to <code>false</code>, because the null data model cannot evaluate <code>&lt;foreach&gt;</code> blocks.</p>
<!-- @@@evaluateForeach -->
<!-- $$$evaluateInitialization[overload1]$$$evaluateInitializationQScxmlExecutableContent::EvaluatorIdbool* -->
<h3 class="fn" id="evaluateInitialization"><a name="evaluateInitialization"></a><code>[override virtual] </code><span class="type">void</span> QScxmlNullDataModel::<span class="name">evaluateInitialization</span>(<span class="type"><a href="qscxmlexecutablecontent.html#EvaluatorId-typedef">QScxmlExecutableContent::EvaluatorId</a></span> <i>id</i>, <span class="type">bool</span> *<i>ok</i>)</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#evaluateInitialization">QScxmlDataModel::evaluateInitialization</a>().</p>
<p>Throws an error and sets <i>ok</i> to <code>false</code>, because the null data model cannot initialize data.</p>
<!-- @@@evaluateInitialization -->
<!-- $$$evaluateToBool[overload1]$$$evaluateToBoolQScxmlExecutableContent::EvaluatorIdbool* -->
<h3 class="fn" id="evaluateToBool"><a name="evaluateToBool"></a><code>[override virtual] </code><span class="type">bool</span> QScxmlNullDataModel::<span class="name">evaluateToBool</span>(<span class="type"><a href="qscxmlexecutablecontent.html#EvaluatorId-typedef">QScxmlExecutableContent::EvaluatorId</a></span> <i>id</i>, <span class="type">bool</span> *<i>ok</i>)</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#evaluateToBool">QScxmlDataModel::evaluateToBool</a>().</p>
<p>Evaluates the executable content pointed to by <i>id</i> and records in <i>ok</i> whether there was an error. Returns the result of the evaluation as a boolean value. The null data model can evaluate the instruction <code>In(..&#x2e;)</code>, so this might result in an actual value, rather than an error.</p>
<!-- @@@evaluateToBool -->
<!-- $$$evaluateToString[overload1]$$$evaluateToStringQScxmlExecutableContent::EvaluatorIdbool* -->
<h3 class="fn" id="evaluateToString"><a name="evaluateToString"></a><code>[override virtual] </code><span class="type">QString</span> QScxmlNullDataModel::<span class="name">evaluateToString</span>(<span class="type"><a href="qscxmlexecutablecontent.html#EvaluatorId-typedef">QScxmlExecutableContent::EvaluatorId</a></span> <i>id</i>, <span class="type">bool</span> *<i>ok</i>)</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#evaluateToString">QScxmlDataModel::evaluateToString</a>().</p>
<p>Evaluates the executable content pointed to by <i>id</i> and records in <i>ok</i> whether there was an error. Returns the result of the evaluation as a string. The null data model can evaluate the <code>&lt;log&gt;</code> element, so this might result in an actual value, rather than an error</p>
<!-- @@@evaluateToString -->
<!-- $$$evaluateToVariant[overload1]$$$evaluateToVariantQScxmlExecutableContent::EvaluatorIdbool* -->
<h3 class="fn" id="evaluateToVariant"><a name="evaluateToVariant"></a><code>[override virtual] </code><span class="type">QVariant</span> QScxmlNullDataModel::<span class="name">evaluateToVariant</span>(<span class="type"><a href="qscxmlexecutablecontent.html#EvaluatorId-typedef">QScxmlExecutableContent::EvaluatorId</a></span> <i>id</i>, <span class="type">bool</span> *<i>ok</i>)</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#evaluateToVariant">QScxmlDataModel::evaluateToVariant</a>().</p>
<p>Evaluates the executable content pointed to by <i>id</i> and records in <i>ok</i> whether there was an error. As this is the null data model, any evaluation will in fact result in an error, with <i>ok</i> set to <code>false</code>. Returns an empty QVariant.</p>
<!-- @@@evaluateToVariant -->
<!-- $$$evaluateToVoid[overload1]$$$evaluateToVoidQScxmlExecutableContent::EvaluatorIdbool* -->
<h3 class="fn" id="evaluateToVoid"><a name="evaluateToVoid"></a><code>[override virtual] </code><span class="type">void</span> QScxmlNullDataModel::<span class="name">evaluateToVoid</span>(<span class="type"><a href="qscxmlexecutablecontent.html#EvaluatorId-typedef">QScxmlExecutableContent::EvaluatorId</a></span> <i>id</i>, <span class="type">bool</span> *<i>ok</i>)</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#evaluateToVoid">QScxmlDataModel::evaluateToVoid</a>().</p>
<p>Evaluates the executable content pointed to by <i>id</i> and records in <i>ok</i> whether there was an error. As this is the null data model, any evaluation will in fact result in an error, with <i>ok</i> set to <code>false</code>.</p>
<!-- @@@evaluateToVoid -->
<!-- $$$hasScxmlProperty[overload1]$$$hasScxmlPropertyconstQString& -->
<h3 class="fn" id="hasScxmlProperty"><a name="hasScxmlProperty"></a><code>[override virtual] </code><span class="type">bool</span> QScxmlNullDataModel::<span class="name">hasScxmlProperty</span>(const <span class="type">QString</span> &amp;<i>name</i>) const</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#hasScxmlProperty">QScxmlDataModel::hasScxmlProperty</a>().</p>
<p>Returns <code>false</code>, because the null data model does not support properties.</p>
<!-- @@@hasScxmlProperty -->
<!-- $$$scxmlProperty[overload1]$$$scxmlPropertyconstQString& -->
<h3 class="fn" id="scxmlProperty"><a name="scxmlProperty"></a><code>[override virtual] </code><span class="type">QVariant</span> QScxmlNullDataModel::<span class="name">scxmlProperty</span>(const <span class="type">QString</span> &amp;<i>name</i>) const</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#scxmlProperty">QScxmlDataModel::scxmlProperty</a>().</p>
<p>Returns an invalid variant, because the null data model does not support properties.</p>
<p><b>See also </b><a href="qscxmlnulldatamodel.html#setScxmlProperty">setScxmlProperty</a>().</p>
<!-- @@@scxmlProperty -->
<!-- $$$setScxmlEvent[overload1]$$$setScxmlEventconstQScxmlEvent& -->
<h3 class="fn" id="setScxmlEvent"><a name="setScxmlEvent"></a><code>[override virtual] </code><span class="type">void</span> QScxmlNullDataModel::<span class="name">setScxmlEvent</span>(const <span class="type"><a href="qscxmlevent.html">QScxmlEvent</a></span> &amp;<i>event</i>)</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#setScxmlEvent">QScxmlDataModel::setScxmlEvent</a>().</p>
<p>Does not actually set the <i>event</i>, because the null data model does not handle events.</p>
<!-- @@@setScxmlEvent -->
<!-- $$$setScxmlProperty[overload1]$$$setScxmlPropertyconstQString&constQVariant&constQString& -->
<h3 class="fn" id="setScxmlProperty"><a name="setScxmlProperty"></a><code>[override virtual] </code><span class="type">bool</span> QScxmlNullDataModel::<span class="name">setScxmlProperty</span>(const <span class="type">QString</span> &amp;<i>name</i>, const <span class="type">QVariant</span> &amp;<i>value</i>, const <span class="type">QString</span> &amp;<i>context</i>)</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#setScxmlProperty">QScxmlDataModel::setScxmlProperty</a>().</p>
<p>Returns <code>false</code>, because the null data model does not support properties.</p>
<p><b>See also </b><a href="qscxmlnulldatamodel.html#scxmlProperty">scxmlProperty</a>().</p>
<!-- @@@setScxmlProperty -->
<!-- $$$setup[overload1]$$$setupconstQVariantMap& -->
<h3 class="fn" id="setup"><a name="setup"></a><code>[override virtual] </code><span class="type">bool</span> QScxmlNullDataModel::<span class="name">setup</span>(const <span class="type">QVariantMap</span> &amp;<i>initialDataValues</i>)</h3>
<p>Reimplemented from <a href="qscxmldatamodel.html#setup">QScxmlDataModel::setup</a>().</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@setup -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2019 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>