rtabmap/preview/pr-1492/api/latest/classULogEvent.html

<!-- HTML header for doxygen 1.9.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RTAB-Map: ULogEvent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">window.RTABMAP_DOC_ROOT="";</script>
<script type="text/javascript" src="../versions.js"></script>
<script type="text/javascript" src="version-switcher.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">RTAB-Map<span id="projectnumber">&#160;0.23.10</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classULogEvent-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ULogEvent Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="ULogger_8h_source.html">ULogger.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ULogEvent:</div>
<div class="dyncontent">
<div class="center"><img src="classULogEvent__inherit__graph.png" border="0" usemap="#aULogEvent_inherit__map" alt="Inheritance graph"/></div>
<map name="aULogEvent_inherit__map" id="aULogEvent_inherit__map">
<area shape="rect" title=" " alt="" coords="5,79,97,104"/>
<area shape="rect" href="classUEvent.html" title=" " alt="" coords="17,5,86,31"/>
<area shape="poly" title=" " alt="" coords="54,44,54,79,49,79,49,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ULogEvent:</div>
<div class="dyncontent">
<div class="center"><img src="classULogEvent__coll__graph.png" border="0" usemap="#aULogEvent_coll__map" alt="Collaboration graph"/></div>
<map name="aULogEvent_coll__map" id="aULogEvent_coll__map">
<area shape="rect" title=" " alt="" coords="5,79,97,104"/>
<area shape="rect" href="classUEvent.html" title=" " alt="" coords="17,5,86,31"/>
<area shape="poly" title=" " alt="" coords="54,44,54,79,49,79,49,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa403fb381a5bfd2986f08c10f0b1b24e" id="r_aa403fb381a5bfd2986f08c10f0b1b24e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classULogEvent.html#aa403fb381a5bfd2986f08c10f0b1b24e">ULogEvent</a> (const std::string &amp;msg, int level)</td></tr>
<tr class="separator:aa403fb381a5bfd2986f08c10f0b1b24e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a460976b037ecf8357fc3fa3f613e5817" id="r_a460976b037ecf8357fc3fa3f613e5817"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classULogEvent.html#a460976b037ecf8357fc3fa3f613e5817">getMsg</a> () const</td></tr>
<tr class="separator:a460976b037ecf8357fc3fa3f613e5817"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70ec329f7f43a18805469302ffddc610" id="r_a70ec329f7f43a18805469302ffddc610"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classULogEvent.html#a70ec329f7f43a18805469302ffddc610">getClassName</a> () const</td></tr>
<tr class="separator:a70ec329f7f43a18805469302ffddc610"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classUEvent"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classUEvent')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classUEvent.html">UEvent</a></td></tr>
<tr class="memitem:a7356350719dfd5ba2d28368d1fdcd143 inherit pub_methods_classUEvent" id="r_a7356350719dfd5ba2d28368d1fdcd143"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUEvent.html#a7356350719dfd5ba2d28368d1fdcd143">getCode</a> () const</td></tr>
<tr class="separator:a7356350719dfd5ba2d28368d1fdcd143 inherit pub_methods_classUEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classUEvent"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classUEvent')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classUEvent.html">UEvent</a></td></tr>
<tr class="memitem:a662b610c2e9ebaae5e91ed5ea1dcef34 inherit pro_methods_classUEvent" id="r_a662b610c2e9ebaae5e91ed5ea1dcef34"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUEvent.html#a662b610c2e9ebaae5e91ed5ea1dcef34">UEvent</a> (int code=0)</td></tr>
<tr class="separator:a662b610c2e9ebaae5e91ed5ea1dcef34 inherit pro_methods_classUEvent"><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>This class is used by the <a class="el" href="classULogger.html">ULogger</a> to send logged messages like events. Messages with level over the event level set in <a class="el" href="classULogger.html#ac0705dc7bc5da07ce27351eb6519e942">ULogger::setEventLevel()</a> are sent like <a class="el" href="classULogEvent.html">ULogEvent</a> with the message and its level. The default event level of <a class="el" href="classULogger.html">ULogger</a> is kFatal (see <a class="el" href="classULogger.html#a4f71cd491aa60029eb6ea4bf79c06218">ULogger::Level</a>). </p>

<p class="definition">Definition at line <a class="el" href="ULogger_8h_source.html#l00121">121</a> of file <a class="el" href="ULogger_8h_source.html">ULogger.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa403fb381a5bfd2986f08c10f0b1b24e" name="aa403fb381a5bfd2986f08c10f0b1b24e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa403fb381a5bfd2986f08c10f0b1b24e">&#9670;&#160;</a></span>ULogEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ULogEvent::ULogEvent </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>level</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classULogEvent.html">ULogEvent</a> constructor. Note that to retrieve the message level, use <a class="el" href="classUEvent.html#a7356350719dfd5ba2d28368d1fdcd143">UEvent::getCode()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msg</td><td>the message already formatted to a full string. </td></tr>
    <tr><td class="paramname">level</td><td>the severity of the message, </td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classULogger.html#a4f71cd491aa60029eb6ea4bf79c06218">ULogger::Level</a>. </dd></dl>

<p class="definition">Definition at line <a class="el" href="ULogger_8h_source.html#l00129">129</a> of file <a class="el" href="ULogger_8h_source.html">ULogger.h</a>.</p>

</div>
</div>
<a id="ae1cd1ae8694b99ada7f5a2ee4fb8c73a" name="ae1cd1ae8694b99ada7f5a2ee4fb8c73a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1cd1ae8694b99ada7f5a2ee4fb8c73a">&#9670;&#160;</a></span>~ULogEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ULogEvent::~ULogEvent </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="ULogger_8h_source.html#l00133">133</a> of file <a class="el" href="ULogger_8h_source.html">ULogger.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a460976b037ecf8357fc3fa3f613e5817" name="a460976b037ecf8357fc3fa3f613e5817"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a460976b037ecf8357fc3fa3f613e5817">&#9670;&#160;</a></span>getMsg()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const std::string &amp; ULogEvent::getMsg </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Get the message from the event. </p>

<p class="definition">Definition at line <a class="el" href="ULogger_8h_source.html#l00137">137</a> of file <a class="el" href="ULogger_8h_source.html">ULogger.h</a>.</p>

</div>
</div>
<a id="a70ec329f7f43a18805469302ffddc610" name="a70ec329f7f43a18805469302ffddc610"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70ec329f7f43a18805469302ffddc610">&#9670;&#160;</a></span>getClassName()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string ULogEvent::getClassName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>string "ULogEvent" </dd></dl>

<p>Implements <a class="el" href="classUEvent.html#a2c7d278240ad4b7d88a2c534cc5f47b4">UEvent</a>.</p>

<p class="definition">Definition at line <a class="el" href="ULogger_8h_source.html#l00141">141</a> of file <a class="el" href="ULogger_8h_source.html">ULogger.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>utilite/include/rtabmap/utilite/<a class="el" href="ULogger_8h_source.html">ULogger.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>