deploy: 12063dd

Author: kmilo17pet

bitfield_8hpp_source.html

@@ -258,16 +258,29 @@
 <div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span></div>
 <div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span>            <span class="keywordtype">void</span>* <a class="code hl_function" href="classqlibs_1_1bitfield.html#a8c09e3f23d830fd47d82250a2893ceca">dump</a>( <span class="keywordtype">void</span> * <span class="keyword">const</span> dst,</div>
 <div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span>                        <span class="keyword">const</span> <span class="keywordtype">size_t</span> n ) <span class="keyword">noexcept</span>;</div>
-<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span>    };</div>
+<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span></div>
+<div class="foldopen" id="foldopen00221" data-start="{" data-end="}">
+<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"><a class="line" href="classqlibs_1_1bitfield.html#a276cdfca65788c0d4097e94017c9d680">  221</a></span>            <span class="keywordtype">bool</span> <a class="code hl_function" href="classqlibs_1_1bitfield.html#a276cdfca65788c0d4097e94017c9d680">isInitialized</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{</div>
+<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span>                <span class="keywordflow">return</span> ( <span class="keyword">nullptr</span> != field );</div>
+<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span>            }</div>
 </div>
-<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span></div>
-<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span>}</div>
-<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span> </div>
-<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span> </div>
-<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="preprocessor">#endif </span><span class="comment">/*QLIBS_BITFIELD*/</span><span class="preprocessor"></span></div>
+<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span></div>
+<div class="foldopen" id="foldopen00229" data-start="{" data-end="}">
+<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"><a class="line" href="classqlibs_1_1bitfield.html#a65d9c9bffedc485f19ba93753e5fea2f">  229</a></span>            <span class="keyword">explicit</span> <span class="keyword">operator</span> bool() const noexcept {</div>
+<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span>                <span class="keywordflow">return</span> <a class="code hl_function" href="classqlibs_1_1bitfield.html#a276cdfca65788c0d4097e94017c9d680">isInitialized</a>();</div>
+<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span>            }</div>
+</div>
+<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span>    };</div>
+</div>
+<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span></div>
+<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span>}</div>
+<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span> </div>
+<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span> </div>
+<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="preprocessor">#endif </span><span class="comment">/*QLIBS_BITFIELD*/</span><span class="preprocessor"></span></div>
 <div class="ttc" id="aclassqlibs_1_1bitfield_html_a096b26f09e65b118b5d6ed1d95b8e37e"><div class="ttname"><a href="classqlibs_1_1bitfield.html#a096b26f09e65b118b5d6ed1d95b8e37e">qlibs::bitfield::readUINTn</a></div><div class="ttdeci">uint32_t readUINTn(const size_t index, const size_t xBits) const noexcept</div><div class="ttdoc">Reads an unsigned 32-bit value from the BitField.</div><div class="ttdef"><b>Definition</b> bitfield.cpp:113</div></div>
 <div class="ttc" id="aclassqlibs_1_1bitfield_html_a1a9332e8dc444603ffeaccb72f039e74"><div class="ttname"><a href="classqlibs_1_1bitfield.html#a1a9332e8dc444603ffeaccb72f039e74">qlibs::bitfield::clearAll</a></div><div class="ttdeci">bool clearAll(void) noexcept</div><div class="ttdoc">Clear all the bits in the BitField.</div><div class="ttdef"><b>Definition</b> bitfield.cpp:25</div></div>
 <div class="ttc" id="aclassqlibs_1_1bitfield_html_a1b5c5d435a54c81220d93803c384bada"><div class="ttname"><a href="classqlibs_1_1bitfield.html#a1b5c5d435a54c81220d93803c384bada">qlibs::bitfield::clearBit</a></div><div class="ttdeci">bool clearBit(const size_t index) noexcept</div><div class="ttdoc">Clears one bit in a BitField.</div><div class="ttdef"><b>Definition</b> bitfield.cpp:60</div></div>
+<div class="ttc" id="aclassqlibs_1_1bitfield_html_a276cdfca65788c0d4097e94017c9d680"><div class="ttname"><a href="classqlibs_1_1bitfield.html#a276cdfca65788c0d4097e94017c9d680">qlibs::bitfield::isInitialized</a></div><div class="ttdeci">bool isInitialized(void) const</div><div class="ttdoc">Check if the bit-field instance has been initialized.</div><div class="ttdef"><b>Definition</b> bitfield.hpp:221</div></div>
 <div class="ttc" id="aclassqlibs_1_1bitfield_html_a2c3512c8c82942b1bed870fbaa5d18c5"><div class="ttname"><a href="classqlibs_1_1bitfield.html#a2c3512c8c82942b1bed870fbaa5d18c5">qlibs::bitfield::setup</a></div><div class="ttdeci">bool setup(uint8_t(&amp;area)[area_size])</div><div class="ttdoc">Setup a initialize a BitField instance.</div><div class="ttdef"><b>Definition</b> bitfield.hpp:116</div></div>
 <div class="ttc" id="aclassqlibs_1_1bitfield_html_a4a341fe55ab7bd1268295bbebd95c69a"><div class="ttname"><a href="classqlibs_1_1bitfield.html#a4a341fe55ab7bd1268295bbebd95c69a">qlibs::bitfield::readBit</a></div><div class="ttdeci">bool readBit(const size_t index) const noexcept</div><div class="ttdoc">Retrieve the state of a bit in a bitfield.</div><div class="ttdef"><b>Definition</b> bitfield.cpp:84</div></div>
 <div class="ttc" id="aclassqlibs_1_1bitfield_html_a54bd31f8c51df852088a2bb74709b2e4"><div class="ttname"><a href="classqlibs_1_1bitfield.html#a54bd31f8c51df852088a2bb74709b2e4">qlibs::bitfield::setup</a></div><div class="ttdeci">bool setup(void *const area, const size_t area_size) noexcept</div><div class="ttdoc">Setup a initialize a BitField instance.</div><div class="ttdef"><b>Definition</b> bitfield.cpp:8</div></div>

classqlibs_1_1bitfield-members.html

@@ -148,6 +148,8 @@
   <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html#a1a9332e8dc444603ffeaccb72f039e74">clearAll</a>(void) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html">qlibs::bitfield</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html#a1b5c5d435a54c81220d93803c384bada">clearBit</a>(const size_t index) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html">qlibs::bitfield</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html#a8c09e3f23d830fd47d82250a2893ceca">dump</a>(void *const dst, const size_t n) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html">qlibs::bitfield</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html#a276cdfca65788c0d4097e94017c9d680">isInitialized</a>(void) const</td><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html">qlibs::bitfield</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html#a65d9c9bffedc485f19ba93753e5fea2f">operator bool</a>() const noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html">qlibs::bitfield</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html#a4a341fe55ab7bd1268295bbebd95c69a">readBit</a>(const size_t index) const noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html">qlibs::bitfield</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html#aae351d60490ae87b58a77e6dd85ff9e8">readFloat</a>(const size_t index) const noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html">qlibs::bitfield</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html#a096b26f09e65b118b5d6ed1d95b8e37e">readUINTn</a>(const size_t index, const size_t xBits) const noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1bitfield.html">qlibs::bitfield</a></td><td class="entry"></td></tr>

classqlibs_1_1bitfield.html

@@ -205,6 +205,12 @@
 <tr class="memitem:a8c09e3f23d830fd47d82250a2893ceca" id="r_a8c09e3f23d830fd47d82250a2893ceca"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8c09e3f23d830fd47d82250a2893ceca">dump</a> (void *const dst, const size_t n) noexcept</td></tr>
 <tr class="memdesc:a8c09e3f23d830fd47d82250a2893ceca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies <em class="arg">n</em> bytes from the bit-field instance to a designed memory area.  <br /></td></tr>
 <tr class="separator:a8c09e3f23d830fd47d82250a2893ceca"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a276cdfca65788c0d4097e94017c9d680" id="r_a276cdfca65788c0d4097e94017c9d680"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a276cdfca65788c0d4097e94017c9d680">isInitialized</a> (void) const</td></tr>
+<tr class="memdesc:a276cdfca65788c0d4097e94017c9d680"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the bit-field instance has been initialized.  <br /></td></tr>
+<tr class="separator:a276cdfca65788c0d4097e94017c9d680"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a65d9c9bffedc485f19ba93753e5fea2f" id="r_a65d9c9bffedc485f19ba93753e5fea2f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a65d9c9bffedc485f19ba93753e5fea2f">operator bool</a> () const noexcept</td></tr>
+<tr class="memdesc:a65d9c9bffedc485f19ba93753e5fea2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the bit-field instance has been initialized.  <br /></td></tr>
+<tr class="separator:a65d9c9bffedc485f19ba93753e5fea2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>A BitField object. </p>
@@ -359,6 +365,62 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8c09e3f23d830fd47d82250a
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>Destination is returned on success, otherwise <code>nullptr</code>. </dd></dl>
 
+</div>
+</div>
+<a id="a276cdfca65788c0d4097e94017c9d680" name="a276cdfca65788c0d4097e94017c9d680"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a276cdfca65788c0d4097e94017c9d680">&#9670;&#160;</a></span>isInitialized()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool qlibs::bitfield::isInitialized </td>
+          <td>(</td>
+          <td class="paramtype">void</td>          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel inline">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Check if the bit-field instance has been initialized. </p>
+<dl class="section return"><dt>Returns</dt><dd><code>true</code> if instance has been initialized </dd></dl>
+
+</div>
+</div>
+<a id="a65d9c9bffedc485f19ba93753e5fea2f" name="a65d9c9bffedc485f19ba93753e5fea2f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a65d9c9bffedc485f19ba93753e5fea2f">&#9670;&#160;</a></span>operator bool()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">qlibs::bitfield::operator bool </td>
+          <td>(</td>
+          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel explicit">explicit</span><span class="mlabel noexcept">noexcept</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Check if the bit-field instance has been initialized. </p>
+<dl class="section return"><dt>Returns</dt><dd><code>true</code> if instance has been initialized </dd></dl>
+
 </div>
 </div>
 <a id="a4a341fe55ab7bd1268295bbebd95c69a" name="a4a341fe55ab7bd1268295bbebd95c69a"></a>

classqlibs_1_1bitfield.js

@@ -5,6 +5,8 @@ var classqlibs_1_1bitfield =
     [ "clearAll", "classqlibs_1_1bitfield.html#a1a9332e8dc444603ffeaccb72f039e74", null ],
     [ "clearBit", "classqlibs_1_1bitfield.html#a1b5c5d435a54c81220d93803c384bada", null ],
     [ "dump", "classqlibs_1_1bitfield.html#a8c09e3f23d830fd47d82250a2893ceca", null ],
+    [ "isInitialized", "classqlibs_1_1bitfield.html#a276cdfca65788c0d4097e94017c9d680", null ],
+    [ "operator bool", "classqlibs_1_1bitfield.html#a65d9c9bffedc485f19ba93753e5fea2f", null ],
     [ "readBit", "classqlibs_1_1bitfield.html#a4a341fe55ab7bd1268295bbebd95c69a", null ],
     [ "readFloat", "classqlibs_1_1bitfield.html#aae351d60490ae87b58a77e6dd85ff9e8", null ],
     [ "readUINTn", "classqlibs_1_1bitfield.html#a096b26f09e65b118b5d6ed1d95b8e37e", null ],