joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 17:56:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add doxygen docs and link to them from main page

Browse source
This commit is contained in:
thephez 2017-12-14 15:34:41 -05:00
parent d327ad9771
commit f94fdd7239
5496 changed files with 984413 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

350
en/doxygen/html/classAbstractThresholdConditionChecker.html Normal file
View file

@ -0,0 +1,350 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: AbstractThresholdConditionChecker 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="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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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>
</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classAbstractThresholdConditionChecker.html','');});
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classAbstractThresholdConditionChecker-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AbstractThresholdConditionChecker Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="versionbits_8h_source.html">versionbits.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for AbstractThresholdConditionChecker:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classAbstractThresholdConditionChecker.png" usemap="#AbstractThresholdConditionChecker_map" alt=""/>
<map id="AbstractThresholdConditionChecker_map" name="AbstractThresholdConditionChecker_map">
<area href="classWarningBitsConditionChecker.html" alt="WarningBitsConditionChecker" shape="rect" coords="0,56,216,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7986d06396d52f6961d7c983dc68b8f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="versionbits_8h.html#ae7f620361ae33b80687a42adb26fd7a4">ThresholdState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractThresholdConditionChecker.html#a7986d06396d52f6961d7c983dc68b8f3">GetStateFor</a> (const <a class="el" href="classCBlockIndex.html">CBlockIndex</a> *pindexPrev, const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;params, <a class="el" href="versionbits_8h.html#a06fae3f599b3fadc0ea127cd55c111ab">ThresholdConditionCache</a> &amp;cache) const</td></tr>
<tr class="separator:a7986d06396d52f6961d7c983dc68b8f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a242388d3046f69956904f0ea7a1e92ee"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractThresholdConditionChecker.html#a242388d3046f69956904f0ea7a1e92ee">Condition</a> (const <a class="el" href="classCBlockIndex.html">CBlockIndex</a> *pindex, const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;params) const =0</td></tr>
<tr class="separator:a242388d3046f69956904f0ea7a1e92ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd1169fade7a2934d605bc4fa53878c6"><td class="memItemLeft" align="right" valign="top">virtual int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractThresholdConditionChecker.html#abd1169fade7a2934d605bc4fa53878c6">BeginTime</a> (const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;params) const =0</td></tr>
<tr class="separator:abd1169fade7a2934d605bc4fa53878c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a798df83d41a24e8ca12c02fb25d07c1c"><td class="memItemLeft" align="right" valign="top">virtual int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractThresholdConditionChecker.html#a798df83d41a24e8ca12c02fb25d07c1c">EndTime</a> (const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;params) const =0</td></tr>
<tr class="separator:a798df83d41a24e8ca12c02fb25d07c1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34b66faf36426413918aedda5213d110"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractThresholdConditionChecker.html#a34b66faf36426413918aedda5213d110">Period</a> (const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;params) const =0</td></tr>
<tr class="separator:a34b66faf36426413918aedda5213d110"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad01c87d6d551e9d801661d734a270a6c"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractThresholdConditionChecker.html#ad01c87d6d551e9d801661d734a270a6c">Threshold</a> (const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;params) const =0</td></tr>
<tr class="separator:ad01c87d6d551e9d801661d734a270a6c"><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>Abstract class that implements BIP9-style threshold logic, and caches results. </p>
<p class="definition">Definition at line <a class="el" href="versionbits_8h_source.html#l00047">47</a> of file <a class="el" href="versionbits_8h_source.html">versionbits.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="abd1169fade7a2934d605bc4fa53878c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd1169fade7a2934d605bc4fa53878c6">&#9670;&nbsp;</a></span>BeginTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int64_t AbstractThresholdConditionChecker::BeginTime </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;&#160;</td>
<td class="paramname"><em>params</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classWarningBitsConditionChecker.html#ab0aff380fa3d04ad540ce178792dad53">WarningBitsConditionChecker</a>.</p>
<p class="reference">Referenced by <a class="el" href="versionbits_8cpp_source.html#l00027">GetStateFor()</a>.</p>
</div>
</div>
<a id="a242388d3046f69956904f0ea7a1e92ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a242388d3046f69956904f0ea7a1e92ee">&#9670;&nbsp;</a></span>Condition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool AbstractThresholdConditionChecker::Condition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCBlockIndex.html">CBlockIndex</a> *&#160;</td>
<td class="paramname"><em>pindex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;&#160;</td>
<td class="paramname"><em>params</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classWarningBitsConditionChecker.html#aae2fc419d193b147e8fad8121fb5e579">WarningBitsConditionChecker</a>.</p>
<p class="reference">Referenced by <a class="el" href="versionbits_8cpp_source.html#l00027">GetStateFor()</a>.</p>
</div>
</div>
<a id="a798df83d41a24e8ca12c02fb25d07c1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a798df83d41a24e8ca12c02fb25d07c1c">&#9670;&nbsp;</a></span>EndTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int64_t AbstractThresholdConditionChecker::EndTime </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;&#160;</td>
<td class="paramname"><em>params</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classWarningBitsConditionChecker.html#ace6c66438992ea0f798806f39eca83a7">WarningBitsConditionChecker</a>.</p>
<p class="reference">Referenced by <a class="el" href="versionbits_8cpp_source.html#l00027">GetStateFor()</a>.</p>
</div>
</div>
<a id="a7986d06396d52f6961d7c983dc68b8f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7986d06396d52f6961d7c983dc68b8f3">&#9670;&nbsp;</a></span>GetStateFor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="versionbits_8h.html#ae7f620361ae33b80687a42adb26fd7a4">ThresholdState</a> AbstractThresholdConditionChecker::GetStateFor </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCBlockIndex.html">CBlockIndex</a> *&#160;</td>
<td class="paramname"><em>pindexPrev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;&#160;</td>
<td class="paramname"><em>params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="versionbits_8h.html#a06fae3f599b3fadc0ea127cd55c111ab">ThresholdConditionCache</a> &amp;&#160;</td>
<td class="paramname"><em>cache</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="versionbits_8cpp_source.html#l00027">27</a> of file <a class="el" href="versionbits_8cpp_source.html">versionbits.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="validation_8cpp_source.html#l02420">UpdateTip()</a>.</p>
</div>
</div>
<a id="a34b66faf36426413918aedda5213d110"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34b66faf36426413918aedda5213d110">&#9670;&nbsp;</a></span>Period()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int AbstractThresholdConditionChecker::Period </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;&#160;</td>
<td class="paramname"><em>params</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classWarningBitsConditionChecker.html#af6dd78109426020b259b70c07bc858d7">WarningBitsConditionChecker</a>.</p>
<p class="reference">Referenced by <a class="el" href="versionbits_8cpp_source.html#l00027">GetStateFor()</a>.</p>
</div>
</div>
<a id="ad01c87d6d551e9d801661d734a270a6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad01c87d6d551e9d801661d734a270a6c">&#9670;&nbsp;</a></span>Threshold()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int AbstractThresholdConditionChecker::Threshold </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structConsensus_1_1Params.html">Consensus::Params</a> &amp;&#160;</td>
<td class="paramname"><em>params</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classWarningBitsConditionChecker.html#af2de7b32547b0677594b1bfbdacd19ad">WarningBitsConditionChecker</a>.</p>
<p class="reference">Referenced by <a class="el" href="versionbits_8cpp_source.html#l00027">GetStateFor()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="versionbits_8h_source.html">versionbits.h</a></li>
<li>src/<a class="el" href="versionbits_8cpp_source.html">versionbits.cpp</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="classAbstractThresholdConditionChecker.html">AbstractThresholdConditionChecker</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:11 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>