tboudreaux/libcomposition
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
libcomposition/docs/html/exceptions__composition_8h_source.html

190 lines
22 KiB
HTML
Raw Permalink 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" 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>fourdst::libcomposition: src/composition/include/fourdst/composition/exceptions/exceptions_composition.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.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 id="projectrow">
<td id="projectalign">
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v2.2.1</span>
</div>
<div id="projectbrief">Robust atomic species information library</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('exceptions__composition_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">exceptions_composition.h</div></div>
</div><!--header-->
<div class="contents">
<a href="exceptions__composition_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;exception&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="foldopen" id="foldopen00006" data-start="{" data-end="}">
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"><a class="line" href="namespacefourdst_1_1composition_1_1exceptions.html"> 6</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacefourdst_1_1composition_1_1exceptions.html">fourdst::composition::exceptions</a> {</div>
<div class="foldopen" id="foldopen00014" data-start="{" data-end="};">
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html"> 14</a></span> <span class="keyword">class </span><a class="code hl_class" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html">CompositionError</a> : <span class="keyword">public</span> std::exception {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#a4cd69d727a162f90045cd6d4aaf95440"> 19</a></span> std::string <a class="code hl_variable" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#a4cd69d727a162f90045cd6d4aaf95440">m_message</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00025" data-start="{" data-end="}">
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#aef0cd13a4d1eb60b6d75ca5480e9146c"> 25</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#aef0cd13a4d1eb60b6d75ca5480e9146c">CompositionError</a>(<span class="keyword">const</span> std::string&amp; message)</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> : <a class="code hl_variable" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#a4cd69d727a162f90045cd6d4aaf95440">m_message</a>(<a class="code hl_namespace" href="namespacestd.html">std</a>::move(message)) {}</div>
</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="foldopen" id="foldopen00032" data-start="{" data-end="}">
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#ae44ceddb19da8a8cda7ee150b6826d08"> 32</a></span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#ae44ceddb19da8a8cda7ee150b6826d08">what</a>() const noexcept<span class="keyword"> override</span>{</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#a4cd69d727a162f90045cd6d4aaf95440">m_message</a>.c_str();</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> }</div>
</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> };</div>
</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="foldopen" id="foldopen00041" data-start="{" data-end="};">
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1exceptions_1_1InvalidCompositionError.html"> 41</a></span> <span class="keyword">class </span><a class="code hl_class" href="classfourdst_1_1composition_1_1exceptions_1_1InvalidCompositionError.html">InvalidCompositionError</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html">CompositionError</a> {</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">using </span><a class="code hl_function" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#aef0cd13a4d1eb60b6d75ca5480e9146c">CompositionError::CompositionError</a>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> };</div>
</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="foldopen" id="foldopen00051" data-start="{" data-end="};">
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1exceptions_1_1UnregisteredSymbolError.html"> 51</a></span> <span class="keyword">class </span><a class="code hl_class" href="classfourdst_1_1composition_1_1exceptions_1_1UnregisteredSymbolError.html">UnregisteredSymbolError</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html">CompositionError</a> {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">using </span><a class="code hl_function" href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#aef0cd13a4d1eb60b6d75ca5480e9146c">CompositionError::CompositionError</a>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> };</div>
</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="foldopen" id="foldopen00059" data-start="{" data-end="};">
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html"> 59</a></span> <span class="keyword">class </span><a class="code hl_class" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html">SpeciesError</a> : <span class="keyword">public</span> std::exception {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#a07a424e42edd368e6fb5113655ab6d1e"> 61</a></span> std::string <a class="code hl_variable" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#a07a424e42edd368e6fb5113655ab6d1e">m_message</a>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00063" data-start="{" data-end="}">
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#af67ed95557b2511ff5143c7064fc5813"> 63</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#af67ed95557b2511ff5143c7064fc5813">SpeciesError</a>(<span class="keyword">const</span> std::string&amp; message)</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> : <a class="code hl_variable" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#a07a424e42edd368e6fb5113655ab6d1e">m_message</a>(<a class="code hl_namespace" href="namespacestd.html">std</a>::move(message)) {}</div>
</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="foldopen" id="foldopen00066" data-start="{" data-end="}">
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#af0c63f7e05d0c65157b960c654d09b67"> 66</a></span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#af0c63f7e05d0c65157b960c654d09b67">what</a>() const noexcept<span class="keyword"> override </span>{</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#a07a424e42edd368e6fb5113655ab6d1e">m_message</a>.c_str();</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> }</div>
</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> };</div>
</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="foldopen" id="foldopen00077" data-start="{" data-end="};">
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1exceptions_1_1UnknownSymbolError.html"> 77</a></span> <span class="keyword">class </span><a class="code hl_class" href="classfourdst_1_1composition_1_1exceptions_1_1UnknownSymbolError.html">UnknownSymbolError</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html">SpeciesError</a> {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">using </span><a class="code hl_function" href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#af67ed95557b2511ff5143c7064fc5813">SpeciesError::SpeciesError</a>;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> };</div>
</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span>}</div>
</div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1exceptions_1_1CompositionError_html"><div class="ttname"><a href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html">fourdst::composition::exceptions::CompositionError</a></div><div class="ttdoc">Base class for exceptions related to composition objects.</div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00014">exceptions_composition.h:14</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1exceptions_1_1CompositionError_html_a4cd69d727a162f90045cd6d4aaf95440"><div class="ttname"><a href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#a4cd69d727a162f90045cd6d4aaf95440">fourdst::composition::exceptions::CompositionError::m_message</a></div><div class="ttdeci">std::string m_message</div><div class="ttdoc">The error message.</div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00019">exceptions_composition.h:19</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1exceptions_1_1CompositionError_html_ae44ceddb19da8a8cda7ee150b6826d08"><div class="ttname"><a href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#ae44ceddb19da8a8cda7ee150b6826d08">fourdst::composition::exceptions::CompositionError::what</a></div><div class="ttdeci">const char * what() const noexcept override</div><div class="ttdoc">Returns the error message.</div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00032">exceptions_composition.h:32</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1exceptions_1_1CompositionError_html_aef0cd13a4d1eb60b6d75ca5480e9146c"><div class="ttname"><a href="classfourdst_1_1composition_1_1exceptions_1_1CompositionError.html#aef0cd13a4d1eb60b6d75ca5480e9146c">fourdst::composition::exceptions::CompositionError::CompositionError</a></div><div class="ttdeci">CompositionError(const std::string &amp;message)</div><div class="ttdoc">Constructs a CompositionError with an error message.</div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00025">exceptions_composition.h:25</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1exceptions_1_1InvalidCompositionError_html"><div class="ttname"><a href="classfourdst_1_1composition_1_1exceptions_1_1InvalidCompositionError.html">fourdst::composition::exceptions::InvalidCompositionError</a></div><div class="ttdoc">Exception thrown when a composition is in an invalid or inconsistent state.</div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00041">exceptions_composition.h:41</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1exceptions_1_1SpeciesError_html"><div class="ttname"><a href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html">fourdst::composition::exceptions::SpeciesError</a></div><div class="ttdoc">Base class for exceptions related to atomic species.</div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00059">exceptions_composition.h:59</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1exceptions_1_1SpeciesError_html_a07a424e42edd368e6fb5113655ab6d1e"><div class="ttname"><a href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#a07a424e42edd368e6fb5113655ab6d1e">fourdst::composition::exceptions::SpeciesError::m_message</a></div><div class="ttdeci">std::string m_message</div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00061">exceptions_composition.h:61</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1exceptions_1_1SpeciesError_html_af0c63f7e05d0c65157b960c654d09b67"><div class="ttname"><a href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#af0c63f7e05d0c65157b960c654d09b67">fourdst::composition::exceptions::SpeciesError::what</a></div><div class="ttdeci">const char * what() const noexcept override</div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00066">exceptions_composition.h:66</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1exceptions_1_1SpeciesError_html_af67ed95557b2511ff5143c7064fc5813"><div class="ttname"><a href="classfourdst_1_1composition_1_1exceptions_1_1SpeciesError.html#af67ed95557b2511ff5143c7064fc5813">fourdst::composition::exceptions::SpeciesError::SpeciesError</a></div><div class="ttdeci">SpeciesError(const std::string &amp;message)</div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00063">exceptions_composition.h:63</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1exceptions_1_1UnknownSymbolError_html"><div class="ttname"><a href="classfourdst_1_1composition_1_1exceptions_1_1UnknownSymbolError.html">fourdst::composition::exceptions::UnknownSymbolError</a></div><div class="ttdoc">Exception thrown when an unknown symbol is encountered.</div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00077">exceptions_composition.h:77</a></div></div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1exceptions_1_1UnregisteredSymbolError_html"><div class="ttname"><a href="classfourdst_1_1composition_1_1exceptions_1_1UnregisteredSymbolError.html">fourdst::composition::exceptions::UnregisteredSymbolError</a></div><div class="ttdoc">Exception thrown when a symbol is used that has not been registered.</div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00051">exceptions_composition.h:51</a></div></div>
<div class="ttc" id="anamespacefourdst_1_1composition_1_1exceptions_html"><div class="ttname"><a href="namespacefourdst_1_1composition_1_1exceptions.html">fourdst::composition::exceptions</a></div><div class="ttdef"><b>Definition</b> <a href="exceptions__composition_8h_source.html#l00006">exceptions_composition.h:6</a></div></div>
<div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_425afc2e69e55565110382214454a15b.html">composition</a></li><li class="navelem"><a class="el" href="dir_cb6fc2f7165eff3b2362b2440dfaea8e.html">include</a></li><li class="navelem"><a class="el" href="dir_3c9efac6790a3720e63e1a08c00d11f2.html">fourdst</a></li><li class="navelem"><a class="el" href="dir_f0fdd83dd0cb4aa6fd6a832374ae4f05.html">composition</a></li><li class="navelem"><a class="el" href="dir_88aa30610c51652b536406602eb05405.html">exceptions</a></li><li class="navelem"><a class="el" href="exceptions__composition_8h.html">exceptions_composition.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink