lauchmelder/b15f
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
b15f/docs/html/classTimeoutException.html
Tristan Krause 5a49a37e69 updated documentation
2019-12-03 07:43:29 +01:00

248 lines
11 KiB
HTML
Raw Blame History

<!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">
<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.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>B15F: TimeoutException 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" />
</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">B15F
</div>
<div id="projectbrief">Board 15 Famulus Edition</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classTimeoutException-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TimeoutException Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="timeoutexception_8h_source.html">timeoutexception.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for TimeoutException:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classTimeoutException.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa45912234da11ffc9dd3594a1bbc0218"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeoutException.html#aa45912234da11ffc9dd3594a1bbc0218">TimeoutException</a> (const char *message)</td></tr>
<tr class="separator:aa45912234da11ffc9dd3594a1bbc0218"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6e5c200fbfd276f48a6c1163e2d2988"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeoutException.html#ad6e5c200fbfd276f48a6c1163e2d2988">TimeoutException</a> (const std::string &amp;message)</td></tr>
<tr class="separator:ad6e5c200fbfd276f48a6c1163e2d2988"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f686b262d2ccffa0090fda9b44ab540"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeoutException.html#a2f686b262d2ccffa0090fda9b44ab540">~TimeoutException</a> ()=default</td></tr>
<tr class="separator:a2f686b262d2ccffa0090fda9b44ab540"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97eaf01fc39ddb94b060020b42fefd6e"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeoutException.html#a97eaf01fc39ddb94b060020b42fefd6e">what</a> () const throw ()</td></tr>
<tr class="separator:a97eaf01fc39ddb94b060020b42fefd6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae6395f887040521c915b0b8d88dc29e7"><td class="memItemLeft" align="right" valign="top"><a id="ae6395f887040521c915b0b8d88dc29e7"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeoutException.html#ae6395f887040521c915b0b8d88dc29e7">msg_</a></td></tr>
<tr class="memdesc:ae6395f887040521c915b0b8d88dc29e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">failure description <br /></td></tr>
<tr class="separator:ae6395f887040521c915b0b8d88dc29e7"><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>Exception for <a class="el" href="classUSART.html">USART</a> related timeouts. </p>
<p class="definition">Definition at line <a class="el" href="timeoutexception_8h_source.html#l00009">9</a> of file <a class="el" href="timeoutexception_8h_source.html">timeoutexception.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa45912234da11ffc9dd3594a1bbc0218"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa45912234da11ffc9dd3594a1bbc0218">&#9670;&nbsp;</a></span>TimeoutException() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TimeoutException::TimeoutException </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>as c-string </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="timeoutexception_8h_source.html#l00016">16</a> of file <a class="el" href="timeoutexception_8h_source.html">timeoutexception.h</a>.</p>
</div>
</div>
<a id="ad6e5c200fbfd276f48a6c1163e2d2988"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6e5c200fbfd276f48a6c1163e2d2988">&#9670;&nbsp;</a></span>TimeoutException() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TimeoutException::TimeoutException </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>as c++-string </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="timeoutexception_8h_source.html#l00024">24</a> of file <a class="el" href="timeoutexception_8h_source.html">timeoutexception.h</a>.</p>
</div>
</div>
<a id="a2f686b262d2ccffa0090fda9b44ab540"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f686b262d2ccffa0090fda9b44ab540">&#9670;&nbsp;</a></span>~TimeoutException()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual TimeoutException::~TimeoutException </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Standard-destructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a97eaf01fc39ddb94b060020b42fefd6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97eaf01fc39ddb94b060020b42fefd6e">&#9670;&nbsp;</a></span>what()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* TimeoutException::what </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"></td>
</tr>
<tr>
<td align="right"></td><td>)</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>Get failure description </p><dl class="section return"><dt>Returns</dt><dd>error message as c-string </dd></dl>
<p class="definition">Definition at line <a class="el" href="timeoutexception_8h_source.html#l00037">37</a> of file <a class="el" href="timeoutexception_8h_source.html">timeoutexception.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>drv/<a class="el" href="timeoutexception_8h_source.html">timeoutexception.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Dec 3 2019 07:42:52 for B15F by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink