cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716
							<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jolt Physics: Result&lt; Type &gt; Class Template 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  <td id="projectalign">
   <div id="projectname">Jolt Physics
   </div>
   <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</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 */
$(function(){initNavTree('class_result.html',''); initResizable(true); });
/* @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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_result-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Result&lt; Type &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Helper class that either contains a valid result or an error.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_result_8h_source.html">Result.h</a>&gt;</code></p>
<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:a48ea3c542aca44533bbe0467ce7edb32" id="r_a48ea3c542aca44533bbe0467ce7edb32"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a48ea3c542aca44533bbe0467ce7edb32">Result</a> ()</td></tr>
<tr class="memdesc:a48ea3c542aca44533bbe0467ce7edb32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <br /></td></tr>
<tr class="separator:a48ea3c542aca44533bbe0467ce7edb32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cb5b79fcbc7a428276cec91bfc794cb" id="r_a0cb5b79fcbc7a428276cec91bfc794cb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0cb5b79fcbc7a428276cec91bfc794cb">Result</a> (const <a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp;inRHS)</td></tr>
<tr class="memdesc:a0cb5b79fcbc7a428276cec91bfc794cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor.  <br /></td></tr>
<tr class="separator:a0cb5b79fcbc7a428276cec91bfc794cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9e9e7780434af5bdfe5652c0b621862" id="r_ad9e9e7780434af5bdfe5652c0b621862"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad9e9e7780434af5bdfe5652c0b621862">Result</a> (<a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp;&amp;inRHS) noexcept</td></tr>
<tr class="memdesc:ad9e9e7780434af5bdfe5652c0b621862"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor.  <br /></td></tr>
<tr class="separator:ad9e9e7780434af5bdfe5652c0b621862"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace4aa7515162bb6ca532d3be78150328" id="r_ace4aa7515162bb6ca532d3be78150328"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ace4aa7515162bb6ca532d3be78150328">~Result</a> ()</td></tr>
<tr class="memdesc:ace4aa7515162bb6ca532d3be78150328"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <br /></td></tr>
<tr class="separator:ace4aa7515162bb6ca532d3be78150328"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc819aa9c4d980d9a06b48cce8bc2d9a" id="r_acc819aa9c4d980d9a06b48cce8bc2d9a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acc819aa9c4d980d9a06b48cce8bc2d9a">operator=</a> (const <a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp;inRHS)</td></tr>
<tr class="memdesc:acc819aa9c4d980d9a06b48cce8bc2d9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy assignment.  <br /></td></tr>
<tr class="separator:acc819aa9c4d980d9a06b48cce8bc2d9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc2f80e7cd0157e8428e1039bea3be9c" id="r_acc2f80e7cd0157e8428e1039bea3be9c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acc2f80e7cd0157e8428e1039bea3be9c">operator=</a> (<a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp;&amp;inRHS) noexcept</td></tr>
<tr class="memdesc:acc2f80e7cd0157e8428e1039bea3be9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment.  <br /></td></tr>
<tr class="separator:acc2f80e7cd0157e8428e1039bea3be9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14eed4aba60f359e04f44980adcf6125" id="r_a14eed4aba60f359e04f44980adcf6125"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a14eed4aba60f359e04f44980adcf6125">Clear</a> ()</td></tr>
<tr class="memdesc:a14eed4aba60f359e04f44980adcf6125"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear result or error.  <br /></td></tr>
<tr class="separator:a14eed4aba60f359e04f44980adcf6125"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a596c71aec4992abce2ecda10cf827573" id="r_a596c71aec4992abce2ecda10cf827573"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a596c71aec4992abce2ecda10cf827573">IsEmpty</a> () const</td></tr>
<tr class="memdesc:a596c71aec4992abce2ecda10cf827573"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the result is still uninitialized.  <br /></td></tr>
<tr class="separator:a596c71aec4992abce2ecda10cf827573"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06b7e3b8ea77cb4b1fc5ecfa45494167" id="r_a06b7e3b8ea77cb4b1fc5ecfa45494167"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a06b7e3b8ea77cb4b1fc5ecfa45494167">IsValid</a> () const</td></tr>
<tr class="memdesc:a06b7e3b8ea77cb4b1fc5ecfa45494167"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the result is valid.  <br /></td></tr>
<tr class="separator:a06b7e3b8ea77cb4b1fc5ecfa45494167"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3d845db638a6a51467760867bfc472a" id="r_ab3d845db638a6a51467760867bfc472a"><td class="memItemLeft" align="right" valign="top">const Type &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab3d845db638a6a51467760867bfc472a">Get</a> () const</td></tr>
<tr class="memdesc:ab3d845db638a6a51467760867bfc472a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the result value.  <br /></td></tr>
<tr class="separator:ab3d845db638a6a51467760867bfc472a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d4677e046c9d429f9a512342bdd479b" id="r_a2d4677e046c9d429f9a512342bdd479b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d4677e046c9d429f9a512342bdd479b">Set</a> (const Type &amp;inResult)</td></tr>
<tr class="memdesc:a2d4677e046c9d429f9a512342bdd479b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the result value.  <br /></td></tr>
<tr class="separator:a2d4677e046c9d429f9a512342bdd479b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e5e698448fcf24d455121278715015e" id="r_a2e5e698448fcf24d455121278715015e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2e5e698448fcf24d455121278715015e">Set</a> (Type &amp;&amp;inResult)</td></tr>
<tr class="memdesc:a2e5e698448fcf24d455121278715015e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the result value (move value)  <br /></td></tr>
<tr class="separator:a2e5e698448fcf24d455121278715015e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2de3e8315a673e4fc3e627eafad42586" id="r_a2de3e8315a673e4fc3e627eafad42586"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2de3e8315a673e4fc3e627eafad42586">HasError</a> () const</td></tr>
<tr class="memdesc:a2de3e8315a673e4fc3e627eafad42586"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if we had an error.  <br /></td></tr>
<tr class="separator:a2de3e8315a673e4fc3e627eafad42586"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d0fc76c48e6db9cf5918dcc248ee4cb" id="r_a3d0fc76c48e6db9cf5918dcc248ee4cb"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="_s_t_l_allocator_8h.html#acfd9326153e4ff90e162d6e7d3e37c86">String</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3d0fc76c48e6db9cf5918dcc248ee4cb">GetError</a> () const</td></tr>
<tr class="memdesc:a3d0fc76c48e6db9cf5918dcc248ee4cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the error value.  <br /></td></tr>
<tr class="separator:a3d0fc76c48e6db9cf5918dcc248ee4cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22ac380ffc00f33d49466729d22241b0" id="r_a22ac380ffc00f33d49466729d22241b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a22ac380ffc00f33d49466729d22241b0">SetError</a> (const char *inError)</td></tr>
<tr class="memdesc:a22ac380ffc00f33d49466729d22241b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set an error value.  <br /></td></tr>
<tr class="separator:a22ac380ffc00f33d49466729d22241b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad71493b9c42c291fed54ffd80f9b75ab" id="r_ad71493b9c42c291fed54ffd80f9b75ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad71493b9c42c291fed54ffd80f9b75ab">SetError</a> (const string_view &amp;inError)</td></tr>
<tr class="separator:ad71493b9c42c291fed54ffd80f9b75ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07ab82eb7f68bae977f6d50dde14dc1f" id="r_a07ab82eb7f68bae977f6d50dde14dc1f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a07ab82eb7f68bae977f6d50dde14dc1f">SetError</a> (<a class="el" href="_s_t_l_allocator_8h.html#acfd9326153e4ff90e162d6e7d3e37c86">String</a> &amp;&amp;inError)</td></tr>
<tr class="separator:a07ab82eb7f68bae977f6d50dde14dc1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class Type&gt;<br />
class Result&lt; Type &gt;</div><p>Helper class that either contains a valid result or an error. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a48ea3c542aca44533bbe0467ce7edb32" name="a48ea3c542aca44533bbe0467ce7edb32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48ea3c542aca44533bbe0467ce7edb32">&#9670;&#160;</a></span>Result() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_result.html">Result</a>&lt; Type &gt;<a class="el" href="class_result.html">::Result</a> </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></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>Default constructor. </p>

</div>
</div>
<a id="a0cb5b79fcbc7a428276cec91bfc794cb" name="a0cb5b79fcbc7a428276cec91bfc794cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cb5b79fcbc7a428276cec91bfc794cb">&#9670;&#160;</a></span>Result() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_result.html">Result</a>&lt; Type &gt;<a class="el" href="class_result.html">::Result</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></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>Copy constructor. </p>

</div>
</div>
<a id="ad9e9e7780434af5bdfe5652c0b621862" name="ad9e9e7780434af5bdfe5652c0b621862"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9e9e7780434af5bdfe5652c0b621862">&#9670;&#160;</a></span>Result() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_result.html">Result</a>&lt; Type &gt;<a class="el" href="class_result.html">::Result</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp;&amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Move constructor. </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_result.html">Result</a>&lt; Type &gt;::~<a class="el" href="class_result.html">Result</a> </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></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>Destructor. </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::Clear </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></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>Clear result or error. </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const Type &amp; <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::Get </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></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 result value. </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="_s_t_l_allocator_8h.html#acfd9326153e4ff90e162d6e7d3e37c86">String</a> &amp; <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::GetError </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></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 error value. </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::HasError </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></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>Check if we had an error. </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::IsEmpty </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></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>Checks if the result is still uninitialized. </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::IsValid </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></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>Checks if the result is valid. </p>

</div>
</div>
<a id="acc819aa9c4d980d9a06b48cce8bc2d9a" name="acc819aa9c4d980d9a06b48cce8bc2d9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc819aa9c4d980d9a06b48cce8bc2d9a">&#9670;&#160;</a></span>operator=() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp; <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></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>Copy assignment. </p>

</div>
</div>
<a id="acc2f80e7cd0157e8428e1039bea3be9c" name="acc2f80e7cd0157e8428e1039bea3be9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc2f80e7cd0157e8428e1039bea3be9c">&#9670;&#160;</a></span>operator=() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp; <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_result.html">Result</a>&lt; Type &gt; &amp;&amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Move assignment. </p>

</div>
</div>
<a id="a2d4677e046c9d429f9a512342bdd479b" name="a2d4677e046c9d429f9a512342bdd479b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d4677e046c9d429f9a512342bdd479b">&#9670;&#160;</a></span>Set() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::Set </td>
          <td>(</td>
          <td class="paramtype">const Type &amp;</td>          <td class="paramname"><span class="paramname"><em>inResult</em></span></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>Set the result value. </p>

</div>
</div>
<a id="a2e5e698448fcf24d455121278715015e" name="a2e5e698448fcf24d455121278715015e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e5e698448fcf24d455121278715015e">&#9670;&#160;</a></span>Set() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::Set </td>
          <td>(</td>
          <td class="paramtype">Type &amp;&amp;</td>          <td class="paramname"><span class="paramname"><em>inResult</em></span></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>Set the result value (move value) </p>

</div>
</div>
<a id="a22ac380ffc00f33d49466729d22241b0" name="a22ac380ffc00f33d49466729d22241b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22ac380ffc00f33d49466729d22241b0">&#9670;&#160;</a></span>SetError() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::SetError </td>
          <td>(</td>
          <td class="paramtype">const char *</td>          <td class="paramname"><span class="paramname"><em>inError</em></span></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>Set an error value. </p>

</div>
</div>
<a id="ad71493b9c42c291fed54ffd80f9b75ab" name="ad71493b9c42c291fed54ffd80f9b75ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad71493b9c42c291fed54ffd80f9b75ab">&#9670;&#160;</a></span>SetError() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::SetError </td>
          <td>(</td>
          <td class="paramtype">const string_view &amp;</td>          <td class="paramname"><span class="paramname"><em>inError</em></span></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">

</div>
</div>
<a id="a07ab82eb7f68bae977f6d50dde14dc1f" name="a07ab82eb7f68bae977f6d50dde14dc1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07ab82eb7f68bae977f6d50dde14dc1f">&#9670;&#160;</a></span>SetError() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::SetError </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_s_t_l_allocator_8h.html#acfd9326153e4ff90e162d6e7d3e37c86">String</a> &amp;&amp;</td>          <td class="paramname"><span class="paramname"><em>inError</em></span></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">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ada2c3d37778adbf318df78b5bd427e17" name="ada2c3d37778adbf318df78b5bd427e17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada2c3d37778adbf318df78b5bd427e17">&#9670;&#160;</a></span>mError</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_s_t_l_allocator_8h.html#acfd9326153e4ff90e162d6e7d3e37c86">String</a> <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::mError</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The error description if the result failed. </p>

</div>
</div>
<a id="a2540c24a649431bd9bdc679737c7df1d" name="a2540c24a649431bd9bdc679737c7df1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2540c24a649431bd9bdc679737c7df1d">&#9670;&#160;</a></span>mResult</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">Type <a class="el" href="class_result.html">Result</a>&lt; Type &gt;::mResult</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The actual result object. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Jolt/Core/<a class="el" href="_result_8h_source.html">Result.h</a></li>
</ul>
</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="class_result.html">Result</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.12.0 </li>
  </ul>
</div>
</body>
</html>