ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-22 03:55:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: a8d481c2a5

Browse Source
This commit is contained in:
nbougalis
2020-09-08 17:09:25 +00:00
parent 624d5a38ad
commit 2682e5845e
2596 changed files with 124385 additions and 94582 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
CreateTicket_8h_source.html
View File

@@ -101,30 +101,81 @@ $(function() {
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classripple_1_1CreateTicket.html"> 30</a></span>&#160;<span class="keyword">class </span><a class="code" href="classripple_1_1CreateTicket.html">CreateTicket</a> : <span class="keyword">public</span> <a class="code" href="classripple_1_1Transactor.html">Transactor</a></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classripple_1_1CreateTicket.html#ab89b1ca8aa115ca86a323e7a3a3507d1"> 33</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classripple_1_1CreateTicket.html#ab89b1ca8aa115ca86a323e7a3a3507d1">CreateTicket</a>(<a class="code" href="classripple_1_1ApplyContext.html">ApplyContext</a>&amp; ctx) : <a class="code" href="classripple_1_1Transactor.html">Transactor</a>(ctx)</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; }</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classripple_1_1CreateTicket.html#acc764ad1169bf619b5a5c3e69ddf8429"> 33</a></span>&#160; <span class="keyword">static</span> constexpr <a class="code" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ConsequencesFactoryType</a> <a class="code" href="classripple_1_1CreateTicket.html#acc764ad1169bf619b5a5c3e69ddf8429">ConsequencesFactory</a>{<a class="code" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938a429832eac6b9ee7b50a1265131cd2845">Custom</a>};</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classripple_1_1CreateTicket.html#a7b59dcedcf05a0c42fd028b527399d3b"> 35</a></span>&#160; constexpr <span class="keyword">static</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <a class="code" href="classripple_1_1CreateTicket.html#a7b59dcedcf05a0c42fd028b527399d3b">minValidCount</a> = 1;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">static</span> <a class="code" href="classripple_1_1TERSubset.html">NotTEC</a></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="classripple_1_1CreateTicket.html#a3f3875aec1cd490ed05e08362e57031f">preflight</a>(<a class="code" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>&amp; ctx);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="classripple_1_1CreateTicket.html#af93532dc2f2cb57e4a20f2e7bce3b40b">doApply</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;};</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="comment">// A note on how the maxValidCount was determined. The goal is for</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="comment">// a single TicketCreate transaction to not use more compute power than</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">// a single compute-intensive Payment.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">// Timing was performed using a MacBook Pro laptop and a release build</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="comment">// with asserts off. 20 measurements were taken of each of the Payment</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// and TicketCreate transactions and averaged to get timings.</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// For the example compute-intensive Payment a Discrepancy unit test</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="comment">// unit test Payment with 3 paths was chosen. With all the latest</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="comment">// amendments enabled, that Payment::doApply() operation took, on</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="comment">// average, 1.25 ms.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="comment">// Using that same test set up creating 250 Tickets in a single</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// CreateTicket::doApply() in a unit test took, on average, 1.21 ms.</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="comment">// So, for the moment, a single transaction creating 250 Tickets takes</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">// about the same compute time as a single compute-intensive payment.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// October 2018.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classripple_1_1CreateTicket.html#a40f05f8a4d33156b60eabd0b83ae1d0d"> 57</a></span>&#160; constexpr <span class="keyword">static</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <a class="code" href="classripple_1_1CreateTicket.html#a40f05f8a4d33156b60eabd0b83ae1d0d">maxValidCount</a> = 250;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// The maximum number of Tickets an account may hold. If a</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="comment">// TicketCreate would cause an account to own more than this many</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="comment">// tickets, then the TicketCreate will fail.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">// The number was chosen arbitrarily and is an effort toward avoiding</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="comment">// ledger-stuffing with Tickets.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classripple_1_1CreateTicket.html#ad272ad110f64ae37a7899b2dba0747c6"> 65</a></span>&#160; constexpr <span class="keyword">static</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <a class="code" href="classripple_1_1CreateTicket.html#ad272ad110f64ae37a7899b2dba0747c6">maxTicketThreshold</a> = 250;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classripple_1_1CreateTicket.html#ab89b1ca8aa115ca86a323e7a3a3507d1"> 67</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classripple_1_1CreateTicket.html#ab89b1ca8aa115ca86a323e7a3a3507d1">CreateTicket</a>(<a class="code" href="classripple_1_1ApplyContext.html">ApplyContext</a>&amp; ctx) : <a class="code" href="classripple_1_1Transactor.html">Transactor</a>(ctx)</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; {</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; }</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">static</span> <a class="code" href="classripple_1_1TxConsequences.html">TxConsequences</a></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="classripple_1_1CreateTicket.html#a05c7c85550d9b129a841afe65a5321ca">makeTxConsequences</a>(<a class="code" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>&amp; ctx);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">static</span> <a class="code" href="classripple_1_1TERSubset.html">NotTEC</a></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="classripple_1_1CreateTicket.html#a3f3875aec1cd490ed05e08362e57031f">preflight</a>(<a class="code" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>&amp; ctx);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">static</span> <a class="code" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="classripple_1_1CreateTicket.html#aa670a3ff11c7bd38c3b4f406b5d0c9f0">preclaim</a>(<a class="code" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> <span class="keyword">const</span>&amp; ctx);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <a class="code" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <a class="code" href="classripple_1_1CreateTicket.html#af93532dc2f2cb57e4a20f2e7bce3b40b">doApply</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;};</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassripple_1_1CreateTicket_html_a40f05f8a4d33156b60eabd0b83ae1d0d"><div class="ttname"><a href="classripple_1_1CreateTicket.html#a40f05f8a4d33156b60eabd0b83ae1d0d">ripple::CreateTicket::maxValidCount</a></div><div class="ttdeci">constexpr static std::uint32_t maxValidCount</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8h_source.html#l00057">CreateTicket.h:57</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html"><div class="ttname"><a href="classripple_1_1Transactor.html">ripple::Transactor</a></div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00086">Transactor.h:86</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html_ab89b1ca8aa115ca86a323e7a3a3507d1"><div class="ttname"><a href="classripple_1_1CreateTicket.html#ab89b1ca8aa115ca86a323e7a3a3507d1">ripple::CreateTicket::CreateTicket</a></div><div class="ttdeci">CreateTicket(ApplyContext &amp;ctx)</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8h_source.html#l00033">CreateTicket.h:33</a></div></div>
<div class="ttc" id="aclassripple_1_1TERSubset_html"><div class="ttname"><a href="classripple_1_1TERSubset.html">ripple::TERSubset</a></div><div class="ttdef"><b>Definition:</b> <a href="TER_8h_source.html#l00322">TER.h:322</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html_a05c7c85550d9b129a841afe65a5321ca"><div class="ttname"><a href="classripple_1_1CreateTicket.html#a05c7c85550d9b129a841afe65a5321ca">ripple::CreateTicket::makeTxConsequences</a></div><div class="ttdeci">static TxConsequences makeTxConsequences(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8cpp_source.html#l00031">CreateTicket.cpp:31</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html_ab89b1ca8aa115ca86a323e7a3a3507d1"><div class="ttname"><a href="classripple_1_1CreateTicket.html#ab89b1ca8aa115ca86a323e7a3a3507d1">ripple::CreateTicket::CreateTicket</a></div><div class="ttdeci">CreateTicket(ApplyContext &amp;ctx)</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8h_source.html#l00067">CreateTicket.h:67</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html_a5c6d16e9402d182a835f50b37ce9a938"><div class="ttname"><a href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ripple::Transactor::ConsequencesFactoryType</a></div><div class="ttdeci">ConsequencesFactoryType</div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00102">Transactor.h:102</a></div></div>
<div class="ttc" id="aclassripple_1_1TERSubset_html"><div class="ttname"><a href="classripple_1_1TERSubset.html">ripple::TERSubset</a></div><div class="ttdef"><b>Definition:</b> <a href="TER_8h_source.html#l00326">TER.h:326</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html_aa670a3ff11c7bd38c3b4f406b5d0c9f0"><div class="ttname"><a href="classripple_1_1CreateTicket.html#aa670a3ff11c7bd38c3b4f406b5d0c9f0">ripple::CreateTicket::preclaim</a></div><div class="ttdeci">static TER preclaim(PreclaimContext const &amp;ctx)</div><div class="ttdoc">Enforce constraints beyond those of the Transactor base class.</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8cpp_source.html#l00057">CreateTicket.cpp:57</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html_ad272ad110f64ae37a7899b2dba0747c6"><div class="ttname"><a href="classripple_1_1CreateTicket.html#ad272ad110f64ae37a7899b2dba0747c6">ripple::CreateTicket::maxTicketThreshold</a></div><div class="ttdeci">constexpr static std::uint32_t maxTicketThreshold</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8h_source.html#l00065">CreateTicket.h:65</a></div></div>
<div class="ttc" id="aclassripple_1_1ApplyContext_html"><div class="ttname"><a href="classripple_1_1ApplyContext.html">ripple::ApplyContext</a></div><div class="ttdoc">State information when applying a tx.</div><div class="ttdef"><b>Definition:</b> <a href="ApplyContext_8h_source.html#l00035">ApplyContext.h:35</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
<div class="ttc" id="astructripple_1_1PreclaimContext_html"><div class="ttname"><a href="structripple_1_1PreclaimContext.html">ripple::PreclaimContext</a></div><div class="ttdoc">State information when determining if a tx is likely to claim a fee.</div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00053">Transactor.h:53</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html_a5c6d16e9402d182a835f50b37ce9a938a429832eac6b9ee7b50a1265131cd2845"><div class="ttname"><a href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938a429832eac6b9ee7b50a1265131cd2845">ripple::Transactor::Custom</a></div><div class="ttdeci">@ Custom</div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00102">Transactor.h:102</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html_a3f3875aec1cd490ed05e08362e57031f"><div class="ttname"><a href="classripple_1_1CreateTicket.html#a3f3875aec1cd490ed05e08362e57031f">ripple::CreateTicket::preflight</a></div><div class="ttdeci">static NotTEC preflight(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8cpp_source.html#l00030">CreateTicket.cpp:30</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html_a3f3875aec1cd490ed05e08362e57031f"><div class="ttname"><a href="classripple_1_1CreateTicket.html#a3f3875aec1cd490ed05e08362e57031f">ripple::CreateTicket::preflight</a></div><div class="ttdeci">static NotTEC preflight(PreflightContext const &amp;ctx)</div><div class="ttdoc">Enforce constraints beyond those of the Transactor base class.</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8cpp_source.html#l00038">CreateTicket.cpp:38</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html"><div class="ttname"><a href="classripple_1_1CreateTicket.html">ripple::CreateTicket</a></div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8h_source.html#l00030">CreateTicket.h:30</a></div></div>
<div class="ttc" id="astructripple_1_1PreflightContext_html"><div class="ttname"><a href="structripple_1_1PreflightContext.html">ripple::PreflightContext</a></div><div class="ttdoc">State information when preflighting a tx.</div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00032">Transactor.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html_af93532dc2f2cb57e4a20f2e7bce3b40b"><div class="ttname"><a href="classripple_1_1CreateTicket.html#af93532dc2f2cb57e4a20f2e7bce3b40b">ripple::CreateTicket::doApply</a></div><div class="ttdeci">TER doApply() override</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8cpp_source.html#l00055">CreateTicket.cpp:55</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html_acc764ad1169bf619b5a5c3e69ddf8429"><div class="ttname"><a href="classripple_1_1CreateTicket.html#acc764ad1169bf619b5a5c3e69ddf8429">ripple::CreateTicket::ConsequencesFactory</a></div><div class="ttdeci">static constexpr ConsequencesFactoryType ConsequencesFactory</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8h_source.html#l00033">CreateTicket.h:33</a></div></div>
<div class="ttc" id="aclassripple_1_1TxConsequences_html"><div class="ttname"><a href="classripple_1_1TxConsequences.html">ripple::TxConsequences</a></div><div class="ttdoc">Class describing the consequences to the account of applying a transaction if the transaction consume...</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00045">applySteps.h:45</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html_af93532dc2f2cb57e4a20f2e7bce3b40b"><div class="ttname"><a href="classripple_1_1CreateTicket.html#af93532dc2f2cb57e4a20f2e7bce3b40b">ripple::CreateTicket::doApply</a></div><div class="ttdeci">TER doApply() override</div><div class="ttdoc">Precondition: fee collection is likely.</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8cpp_source.html#l00085">CreateTicket.cpp:85</a></div></div>
<div class="ttc" id="aclassripple_1_1CreateTicket_html_a7b59dcedcf05a0c42fd028b527399d3b"><div class="ttname"><a href="classripple_1_1CreateTicket.html#a7b59dcedcf05a0c42fd028b527399d3b">ripple::CreateTicket::minValidCount</a></div><div class="ttdeci">constexpr static std::uint32_t minValidCount</div><div class="ttdef"><b>Definition:</b> <a href="CreateTicket_8h_source.html#l00035">CreateTicket.h:35</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">