mirror of
https://github.com/introlab/rtabmap.git
synced 2026-10-09 19:39:50 +08:00
Update documentation (latest) 0f98c63e9d
This commit is contained in:
github-actions[bot]
@@ -33,7 +33,7 @@
|
||||
<tbody>
|
||||
<tr id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">RTAB-Map<span id="projectnumber"> 0.23.12</span>
|
||||
<div id="projectname">RTAB-Map<span id="projectnumber"> 0.23.13</span>
|
||||
</div>
|
||||
<div id="projectbrief">Real-Time Appearance-Based Mapping</div>
|
||||
</td>
|
||||
@@ -216,37 +216,105 @@ $(document).ready(function(){initNavTree('UMutex_8h_source.html',''); initResiza
|
||||
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span>};</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> </div>
|
||||
<div class="foldopen" id="foldopen00164" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"><a class="line" href="classUScopeMutex.html"> 164</a></span><span class="keyword">class </span><a class="code hl_class" href="classUScopeMutex.html">UScopeMutex</a></div>
|
||||
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span>{</div>
|
||||
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span><span class="keyword">public</span>:</div>
|
||||
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> <a class="code hl_class" href="classUScopeMutex.html">UScopeMutex</a>(<span class="keyword">const</span> <a class="code hl_class" href="classUMutex.html">UMutex</a> & mutex) :</div>
|
||||
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> mutex_(mutex)</div>
|
||||
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> {</div>
|
||||
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> mutex_.<a class="code hl_function" href="classUMutex.html#af42d27a9379e6872e8cf2e5e171e820c">lock</a>();</div>
|
||||
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> }</div>
|
||||
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> <span class="comment">// backward compatibility</span></div>
|
||||
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> <a class="code hl_class" href="classUScopeMutex.html">UScopeMutex</a>(<a class="code hl_class" href="classUMutex.html">UMutex</a> * mutex) :</div>
|
||||
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> mutex_(*mutex)</div>
|
||||
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> {</div>
|
||||
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> mutex_.<a class="code hl_function" href="classUMutex.html#af42d27a9379e6872e8cf2e5e171e820c">lock</a>();</div>
|
||||
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> }</div>
|
||||
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> <a class="code hl_class" href="classUScopeMutex.html">~UScopeMutex</a>()</div>
|
||||
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> {</div>
|
||||
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> mutex_.<a class="code hl_function" href="classUMutex.html#a4c5b4e04ad4e2f0eda2e8d4325d45d38">unlock</a>();</div>
|
||||
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> }</div>
|
||||
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span><span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> <span class="keyword">const</span> <a class="code hl_class" href="classUMutex.html">UMutex</a> & mutex_;</div>
|
||||
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span>};</div>
|
||||
<div class="foldopen" id="foldopen00193" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"><a class="line" href="classUScopeMutex.html"> 193</a></span><span class="keyword">class </span><a class="code hl_class" href="classUScopeMutex.html">UScopeMutex</a></div>
|
||||
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span>{</div>
|
||||
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span><span class="keyword">public</span>:</div>
|
||||
<div class="foldopen" id="foldopen00201" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"><a class="line" href="classUScopeMutex.html#a0edb03132a8182e53bb0c5e960fd2a4b"> 201</a></span> <a class="code hl_function" href="classUScopeMutex.html#a0edb03132a8182e53bb0c5e960fd2a4b">UScopeMutex</a>(<span class="keyword">const</span> <a class="code hl_class" href="classUMutex.html">UMutex</a> & mutex, <span class="keywordtype">bool</span> lockNow = <span class="keyword">true</span>) :</div>
|
||||
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> mutex_(mutex),</div>
|
||||
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span> locked_(false)</div>
|
||||
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> {</div>
|
||||
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> <span class="keywordflow">if</span>(lockNow)</div>
|
||||
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> {</div>
|
||||
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> <a class="code hl_function" href="classUScopeMutex.html#a6515d46f7117d390679f9bf79273488e">lock</a>();</div>
|
||||
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> }</div>
|
||||
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> </div>
|
||||
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span><span class="preprocessor">#endif </span><span class="comment">// UMUTEX_H</span></div>
|
||||
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> <span class="comment">// backward compatibility</span></div>
|
||||
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> <a class="code hl_class" href="classUScopeMutex.html">UScopeMutex</a>(<a class="code hl_class" href="classUMutex.html">UMutex</a> * mutex) :</div>
|
||||
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> mutex_(*mutex),</div>
|
||||
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> locked_(false)</div>
|
||||
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> {</div>
|
||||
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> <a class="code hl_function" href="classUScopeMutex.html#a6515d46f7117d390679f9bf79273488e">lock</a>();</div>
|
||||
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> }</div>
|
||||
<div class="foldopen" id="foldopen00220" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"><a class="line" href="classUScopeMutex.html#a39bf03b3225db08d8a07da0777aee5f5"> 220</a></span> <a class="code hl_function" href="classUScopeMutex.html#a39bf03b3225db08d8a07da0777aee5f5">~UScopeMutex</a>()</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> <a class="code hl_function" href="classUScopeMutex.html#a05eed5425e47144d045c5376e7087248">unlock</a>();</div>
|
||||
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> }</div>
|
||||
</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="classUScopeMutex.html#a6515d46f7117d390679f9bf79273488e"> 229</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classUScopeMutex.html#a6515d46f7117d390679f9bf79273488e">lock</a>() &</div>
|
||||
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> {</div>
|
||||
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> <span class="keywordflow">if</span>(locked_)</div>
|
||||
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> {</div>
|
||||
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> }</div>
|
||||
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> <span class="keywordtype">int</span> r = mutex_.<a class="code hl_function" href="classUMutex.html#af42d27a9379e6872e8cf2e5e171e820c">lock</a>();</div>
|
||||
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> locked_ = r == 0;</div>
|
||||
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> <span class="keywordflow">return</span> r;</div>
|
||||
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> </div>
|
||||
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span><span class="preprocessor">#if !defined(_WIN32) || (_WIN32_WINNT >= 0x0400)</span></div>
|
||||
<div class="foldopen" id="foldopen00246" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"><a class="line" href="classUScopeMutex.html#ab5520a99fb161894c6354d3772b819af"> 246</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classUScopeMutex.html#ab5520a99fb161894c6354d3772b819af">lockTry</a>() &</div>
|
||||
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span> {</div>
|
||||
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"> 248</span> <span class="keywordflow">if</span>(locked_)</div>
|
||||
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> {</div>
|
||||
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span> <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"> 251</span> }</div>
|
||||
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span> <span class="keywordtype">int</span> r = mutex_.<a class="code hl_function" href="classUMutex.html#a6237fbb3142023f92c11989b13207c32">lockTry</a>();</div>
|
||||
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> locked_ = r == 0;</div>
|
||||
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span> <span class="keywordflow">return</span> r;</div>
|
||||
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span><span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span> </div>
|
||||
<div class="foldopen" id="foldopen00262" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno"><a class="line" href="classUScopeMutex.html#a05eed5425e47144d045c5376e7087248"> 262</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classUScopeMutex.html#a05eed5425e47144d045c5376e7087248">unlock</a>() &</div>
|
||||
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno"> 263</span> {</div>
|
||||
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno"> 264</span> <span class="keywordflow">if</span>(!locked_)</div>
|
||||
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span> {</div>
|
||||
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span> }</div>
|
||||
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span> locked_ = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span> <span class="keywordflow">return</span> mutex_.<a class="code hl_function" href="classUMutex.html#a4c5b4e04ad4e2f0eda2e8d4325d45d38">unlock</a>();</div>
|
||||
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno"> 270</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno"> 271</span> </div>
|
||||
<div class="foldopen" id="foldopen00275" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno"><a class="line" href="classUScopeMutex.html#a09b8bde74967224b7a050eca317c79e7"> 275</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classUScopeMutex.html#a09b8bde74967224b7a050eca317c79e7">isLocked</a>()<span class="keyword"> const</span></div>
|
||||
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno"> 276</span><span class="keyword"> </span>{</div>
|
||||
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno"> 277</span> <span class="keywordflow">return</span> locked_;</div>
|
||||
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span> </div>
|
||||
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno"> 280</span><span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno"> 281</span> <a class="code hl_class" href="classUScopeMutex.html">UScopeMutex</a>(<span class="keyword">const</span> <a class="code hl_class" href="classUScopeMutex.html">UScopeMutex</a> &);</div>
|
||||
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno"> 282</span> <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code hl_class" href="classUScopeMutex.html">UScopeMutex</a> &);</div>
|
||||
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span> </div>
|
||||
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno"> 284</span><span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno"> 285</span> <span class="keyword">const</span> <a class="code hl_class" href="classUMutex.html">UMutex</a> & mutex_;</div>
|
||||
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno"> 286</span> <span class="keywordtype">bool</span> locked_;</div>
|
||||
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"> 287</span>};</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno"> 288</span> </div>
|
||||
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno"> 289</span><span class="preprocessor">#endif </span><span class="comment">// UMUTEX_H</span></div>
|
||||
<div class="ttc" id="aclassUMutex_html"><div class="ttname"><a href="classUMutex.html">UMutex</a></div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00054">UMutex.h:55</a></div></div>
|
||||
<div class="ttc" id="aclassUMutex_html_a292198fffdbd7d0d5a550946f156f70e"><div class="ttname"><a href="classUMutex.html#a292198fffdbd7d0d5a550946f156f70e">UMutex::UMutex</a></div><div class="ttdeci">UMutex()</div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00062">UMutex.h:62</a></div></div>
|
||||
<div class="ttc" id="aclassUMutex_html_a4c5b4e04ad4e2f0eda2e8d4325d45d38"><div class="ttname"><a href="classUMutex.html#a4c5b4e04ad4e2f0eda2e8d4325d45d38">UMutex::unlock</a></div><div class="ttdeci">int unlock() const</div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00120">UMutex.h:120</a></div></div>
|
||||
<div class="ttc" id="aclassUMutex_html_a6237fbb3142023f92c11989b13207c32"><div class="ttname"><a href="classUMutex.html#a6237fbb3142023f92c11989b13207c32">UMutex::lockTry</a></div><div class="ttdeci">int lockTry() const</div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00110">UMutex.h:110</a></div></div>
|
||||
<div class="ttc" id="aclassUMutex_html_af42d27a9379e6872e8cf2e5e171e820c"><div class="ttname"><a href="classUMutex.html#af42d27a9379e6872e8cf2e5e171e820c">UMutex::lock</a></div><div class="ttdeci">int lock() const</div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00088">UMutex.h:88</a></div></div>
|
||||
<div class="ttc" id="aclassUScopeMutex_html"><div class="ttname"><a href="classUScopeMutex.html">UScopeMutex</a></div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00164">UMutex.h:165</a></div></div>
|
||||
<div class="ttc" id="aclassUScopeMutex_html"><div class="ttname"><a href="classUScopeMutex.html">UScopeMutex</a></div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00193">UMutex.h:194</a></div></div>
|
||||
<div class="ttc" id="aclassUScopeMutex_html_a05eed5425e47144d045c5376e7087248"><div class="ttname"><a href="classUScopeMutex.html#a05eed5425e47144d045c5376e7087248">UScopeMutex::unlock</a></div><div class="ttdeci">int unlock() &</div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00262">UMutex.h:262</a></div></div>
|
||||
<div class="ttc" id="aclassUScopeMutex_html_a09b8bde74967224b7a050eca317c79e7"><div class="ttname"><a href="classUScopeMutex.html#a09b8bde74967224b7a050eca317c79e7">UScopeMutex::isLocked</a></div><div class="ttdeci">bool isLocked() const</div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00275">UMutex.h:275</a></div></div>
|
||||
<div class="ttc" id="aclassUScopeMutex_html_a0edb03132a8182e53bb0c5e960fd2a4b"><div class="ttname"><a href="classUScopeMutex.html#a0edb03132a8182e53bb0c5e960fd2a4b">UScopeMutex::UScopeMutex</a></div><div class="ttdeci">UScopeMutex(const UMutex &mutex, bool lockNow=true)</div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00201">UMutex.h:201</a></div></div>
|
||||
<div class="ttc" id="aclassUScopeMutex_html_a39bf03b3225db08d8a07da0777aee5f5"><div class="ttname"><a href="classUScopeMutex.html#a39bf03b3225db08d8a07da0777aee5f5">UScopeMutex::~UScopeMutex</a></div><div class="ttdeci">~UScopeMutex()</div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00220">UMutex.h:220</a></div></div>
|
||||
<div class="ttc" id="aclassUScopeMutex_html_a6515d46f7117d390679f9bf79273488e"><div class="ttname"><a href="classUScopeMutex.html#a6515d46f7117d390679f9bf79273488e">UScopeMutex::lock</a></div><div class="ttdeci">int lock() &</div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00229">UMutex.h:229</a></div></div>
|
||||
<div class="ttc" id="aclassUScopeMutex_html_ab5520a99fb161894c6354d3772b819af"><div class="ttname"><a href="classUScopeMutex.html#ab5520a99fb161894c6354d3772b819af">UScopeMutex::lockTry</a></div><div class="ttdeci">int lockTry() &</div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00246">UMutex.h:246</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
|
||||
Reference in New Issue
Block a user