diff options
Diffstat (limited to '0.14/html/debugout_8h.html')
| -rw-r--r-- | 0.14/html/debugout_8h.html | 192 |
1 files changed, 192 insertions, 0 deletions
diff --git a/0.14/html/debugout_8h.html b/0.14/html/debugout_8h.html new file mode 100644 index 00000000..d4d9661e --- /dev/null +++ b/0.14/html/debugout_8h.html @@ -0,0 +1,192 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.11"/> +<title>automotive-message-broker: /home/kev/src/automotive-message-broker/lib/debugout.h File 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> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</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 style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">automotive-message-broker +  <span id="projectnumber">0.14.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.11 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li><a href="examples.html"><span>Examples</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </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"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">debugout.h File Reference<div class="ingroups"><a class="el" href="group__libamb.html">Libamb</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>The <a class="el" href="classDebugOut.html">DebugOut</a> class represents a class used for outputing debug information The specified debug level will only be outputed if the debug level is => the debug threshhold Here's a simple example: +<a href="#details">More...</a></p> +<div class="textblock"><code>#include <string></code><br /> +<code>#include <iostream></code><br /> +<code>#include <fstream></code><br /> +<code>#include <sstream></code><br /> +<code>#include <stdexcept></code><br /> +<code>#include "timestamp.h"</code><br /> +</div><div class="textblock"><div class="dynheader"> +Include dependency graph for debugout.h:</div> +<div class="dyncontent"> +<div class="center"><img src="debugout_8h__incl.png" border="0" usemap="#_2home_2kev_2src_2automotive-message-broker_2lib_2debugout_8h" alt=""/></div> +<map name="_2home_2kev_2src_2automotive-message-broker_2lib_2debugout_8h" id="_2home_2kev_2src_2automotive-message-broker_2lib_2debugout_8h"> +<area shape="rect" id="node7" href="timestamp_8h_source.html" title="timestamp.h" alt="" coords="468,95,563,121"/> +</map> +</div> +</div><div class="textblock"><div class="dynheader"> +This graph shows which files directly or indirectly include this file:</div> +<div class="dyncontent"> +<div class="center"><img src="debugout_8h__dep__incl.png" border="0" usemap="#_2home_2kev_2src_2automotive-message-broker_2lib_2debugout_8hdep" alt=""/></div> +<map name="_2home_2kev_2src_2automotive-message-broker_2lib_2debugout_8hdep" id="_2home_2kev_2src_2automotive-message-broker_2lib_2debugout_8hdep"> +<area shape="rect" id="node2" href="abstractpropertytype_8h_source.html" title="/home/kev/src/automotive\l-message-broker/lib/abstractpropertytype.h" alt="" coords="255,95,526,136"/> +<area shape="rect" id="node3" href="vehicleproperty_8h_source.html" title="/home/kev/src/automotive\l-message-broker/lib/vehicleproperty.h" alt="" coords="193,184,431,225"/> +<area shape="rect" id="node4" href="abstractroutingengine_8h_source.html" title="/home/kev/src/automotive\l-message-broker/lib/abstractroutingengine.h" alt="" coords="5,273,280,315"/> +<area shape="rect" id="node5" href="abstractsource_8h_source.html" title="/home/kev/src/automotive\l-message-broker/lib/abstractsource.h" alt="" coords="272,363,509,404"/> +<area shape="rect" id="node8" href="abstractsink_8h_source.html" title="/home/kev/src/automotive\l-message-broker/lib/abstractsink.h" alt="" coords="354,273,577,315"/> +<area shape="rect" id="node6" href="ambplugin_8h.html" title="Contains common code used in plugins for Automotive message broker(AMB). " alt="" coords="285,541,496,583"/> +<area shape="rect" id="node7" href="ambpluginimpl_8h_source.html" title="/home/kev/src/automotive\l-message-broker/lib/ambpluginimpl.h" alt="" coords="351,452,585,493"/> +</map> +</div> +</div> +<p><a href="debugout_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugOut.html">DebugOut</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a3d223d0e2612ecb7e1999f13c52d5884"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d223d0e2612ecb7e1999f13c52d5884"></a> +void </td><td class="memItemRight" valign="bottom"><b>debugOut</b> (const string &message)</td></tr> +<tr class="separator:a3d223d0e2612ecb7e1999f13c52d5884"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a452c71aeeb6c1b3fffb05381a3c116d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="debugout_8h.html#a452c71aeeb6c1b3fffb05381a3c116d5">amb::deprecateMethod</a> (const string &methodName, const std::string &version)</td></tr> +<tr class="memdesc:a452c71aeeb6c1b3fffb05381a3c116d5"><td class="mdescLeft"> </td><td class="mdescRight">deprecateMethod prints warning if method is used. Throws if version >= PROJECT_SERIES <a href="debugout_8h.html#a452c71aeeb6c1b3fffb05381a3c116d5">More...</a><br /></td></tr> +<tr class="separator:a452c71aeeb6c1b3fffb05381a3c116d5"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>The <a class="el" href="classDebugOut.html">DebugOut</a> class represents a class used for outputing debug information The specified debug level will only be outputed if the debug level is => the debug threshhold Here's a simple example: </p> +<div class="fragment"><div class="line">DebugOut::setDebugThreshhold(3);</div><div class="line"><a class="code" href="classDebugOut.html">DebugOut</a>(<a class="code" href="classDebugOut.html#a7a06aa04dd6cb8c1e9bcd083d30d91ad">DebugOut::Warning</a>) << <span class="stringliteral">"This is a warning"</span> << std::endl;</div><div class="line"><a class="code" href="classDebugOut.html">DebugOut</a>(3) << <span class="stringliteral">"This will only show if the threshhold is 3 or lower."</span> << std::endl;</div><div class="line"></div><div class="line">ofstream logfile;</div><div class="line">logfile.open(<span class="stringliteral">"amb.log"</span>, ios::out | ios::trunc);</div><div class="line">DebugOut::setOutput(logfile)</div><div class="line"></div><div class="line"><a class="code" href="classDebugOut.html">DebugOut</a>::setThrowErr(true);</div><div class="line"><a class="code" href="classDebugOut.html">DebugOut</a>::setThrowWarn(true);</div><div class="line"><a class="code" href="classDebugOut.html">DebugOut</a>(<a class="code" href="classDebugOut.html">DebugOut</a>::Error) << "This will throw an exception." << <a class="code" href="namespacestd.html">std</a>::endl;</div><div class="line"></div><div class="line"><a class="code" href="classDebugOut.html">DebugOut</a>::setOutput(<a class="code" href="namespacestd.html">std</a>::cerr);</div><div class="line"><a class="code" href="classDebugOut.html">DebugOut</a>() << "This will log to stderr." << <a class="code" href="namespacestd.html">std</a>::endl;</div></div><!-- fragment --> </div><h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="file_a452c71aeeb6c1b3fffb05381a3c116d5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void amb::deprecateMethod </td> + <td>(</td> + <td class="paramtype">const string & </td> + <td class="paramname"><em>methodName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>version</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>deprecateMethod prints warning if method is used. Throws if version >= PROJECT_SERIES </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">methodName</td><td>name of method being deprecated. </td></tr> + <tr><td class="paramname">version</td><td>version in which this method will no longer function in. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.11 +</small></address> +</body> +</html> |