Hazelnupp/docs/classHazelnp_1_1HazelnuppException.html

264 lines
14 KiB
HTML
Raw Normal View History

2021-06-03 13:43:05 +02:00
<!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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Leonetienne/Hazelnupp: Hazelnp::HazelnuppException 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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.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="projectlogo"><img alt="Logo" src="nupp_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Leonetienne/Hazelnupp
</div>
<div id="projectbrief">Simple, easy to use, command line parameter interface</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceHazelnp.html">Hazelnp</a></li><li class="navelem"><a class="el" href="classHazelnp_1_1HazelnuppException.html">HazelnuppException</a></li> </ul>
</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="classHazelnp_1_1HazelnuppException-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Hazelnp::HazelnuppException Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Generic hazelnupp exception.
<a href="classHazelnp_1_1HazelnuppException.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Hazelnp::HazelnuppException:</div>
<div class="dyncontent">
<div class="center"><img src="classHazelnp_1_1HazelnuppException__inherit__graph.png" border="0" usemap="#Hazelnp_1_1HazelnuppException_inherit__map" alt="Inheritance graph"/></div>
<map name="Hazelnp_1_1HazelnuppException_inherit__map" id="Hazelnp_1_1HazelnuppException_inherit__map">
<area shape="rect" title="Generic hazelnupp exception." alt="" coords="168,110,384,137"/>
<area shape="rect" href="classHazelnp_1_1HazelnuppConstraintException.html" title="Gets thrown something bad happens because of parameter constraints." alt="" coords="432,37,651,79"/>
<area shape="rect" href="classHazelnp_1_1HazelnuppInvalidKeyException.html" title="Gets thrown when an non&#45;existent key gets dereferenced." alt="" coords="443,103,639,144"/>
<area shape="rect" href="classHazelnp_1_1HazelnuppValueNotConvertibleException.html" title="Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ..." alt="" coords="436,168,647,209"/>
<area shape="rect" title="STL class." alt="" coords="5,110,120,137"/>
<area shape="rect" href="classHazelnp_1_1HazelnuppConstraintMissingValue.html" title="Gets thrown when a parameter constrained to be required is not provided, and has no default value set..." alt="" coords="699,5,917,47"/>
<area shape="rect" href="classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html" title="Gets thrown when a parameter is of a type that does not match the required type, and is not convertib..." alt="" coords="699,71,917,112"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Hazelnp::HazelnuppException:</div>
<div class="dyncontent">
<div class="center"><img src="classHazelnp_1_1HazelnuppException__coll__graph.png" border="0" usemap="#Hazelnp_1_1HazelnuppException_coll__map" alt="Collaboration graph"/></div>
<map name="Hazelnp_1_1HazelnuppException_coll__map" id="Hazelnp_1_1HazelnuppException_coll__map">
<area shape="rect" title="Generic hazelnupp exception." alt="" coords="5,185,221,212"/>
<area shape="rect" title="STL class." alt="" coords="35,96,149,123"/>
<area shape="rect" title="STL class." alt="" coords="174,96,261,123"/>
<area shape="rect" title="STL class." alt="" coords="148,5,287,47"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0b21fd5d4f22e5e677b74eb0acd7c6ff"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHazelnp_1_1HazelnuppException.html#a0b21fd5d4f22e5e677b74eb0acd7c6ff">HazelnuppException</a> ()</td></tr>
<tr class="separator:a0b21fd5d4f22e5e677b74eb0acd7c6ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a816f823fe2ebd35076049e33b9f3c05c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHazelnp_1_1HazelnuppException.html#a816f823fe2ebd35076049e33b9f3c05c">HazelnuppException</a> (const std::string &amp;msg)</td></tr>
<tr class="separator:a816f823fe2ebd35076049e33b9f3c05c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa86c415a0f2b4ea5f11892145d1ea83e"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e">What</a> () const</td></tr>
<tr class="memdesc:aa86c415a0f2b4ea5f11892145d1ea83e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Will return an error message. <a href="classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e">More...</a><br /></td></tr>
<tr class="separator:aa86c415a0f2b4ea5f11892145d1ea83e"><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:aa905cabcd12f542dfc67638732737e88"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHazelnp_1_1HazelnuppException.html#aa905cabcd12f542dfc67638732737e88">message</a></td></tr>
<tr class="separator:aa905cabcd12f542dfc67638732737e88"><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>Generic hazelnupp exception. </p>
<p class="definition">Definition at line <a class="el" href="HazelnuppException_8h_source.html#l00008">8</a> of file <a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0b21fd5d4f22e5e677b74eb0acd7c6ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b21fd5d4f22e5e677b74eb0acd7c6ff">&#9670;&nbsp;</a></span>HazelnuppException() <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">Hazelnp::HazelnuppException::HazelnuppException </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="HazelnuppException_8h_source.html#l00011">11</a> of file <a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;{};</div>
</div><!-- fragment -->
</div>
</div>
<a id="a816f823fe2ebd35076049e33b9f3c05c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a816f823fe2ebd35076049e33b9f3c05c">&#9670;&nbsp;</a></span>HazelnuppException() <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">Hazelnp::HazelnuppException::HazelnuppException </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>msg</em></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 class="definition">Definition at line <a class="el" href="HazelnuppException_8h_source.html#l00012">12</a> of file <a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;: <a class="code" href="classHazelnp_1_1HazelnuppException.html#aa905cabcd12f542dfc67638732737e88">message</a>{ msg } {};</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa86c415a0f2b4ea5f11892145d1ea83e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa86c415a0f2b4ea5f11892145d1ea83e">&#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">const std::string&amp; Hazelnp::HazelnuppException::What </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>Will return an error message. </p>
<p class="definition">Definition at line <a class="el" href="HazelnuppException_8h_source.html#l00015">15</a> of file <a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classHazelnp_1_1HazelnuppException.html#aa905cabcd12f542dfc67638732737e88">message</a>;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa905cabcd12f542dfc67638732737e88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa905cabcd12f542dfc67638732737e88">&#9670;&nbsp;</a></span>message</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string Hazelnp::HazelnuppException::message</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="HazelnuppException_8h_source.html#l00021">21</a> of file <a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Hazelnupp/<a class="el" href="HazelnuppException_8h_source.html">HazelnuppException.h</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="aclassHazelnp_1_1HazelnuppException_html_aa905cabcd12f542dfc67638732737e88"><div class="ttname"><a href="classHazelnp_1_1HazelnuppException.html#aa905cabcd12f542dfc67638732737e88">Hazelnp::HazelnuppException::message</a></div><div class="ttdeci">std::string message</div><div class="ttdef"><b>Definition:</b> <a href="HazelnuppException_8h_source.html#l00021">HazelnuppException.h:21</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
2021-06-05 12:40:24 +02:00
Generated on Sat Jun 5 2021 12:40:12 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
2021-06-03 13:43:05 +02:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>