taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2015-04-02 16:37:15 +10:00
parent 95a162cdfd
commit 772ecf46e8
331 changed files with 835 additions and 566 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
NoiseSource_8h_source.html
View File

@@ -125,21 +125,24 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classNoiseSource.html#ac8ac086f830efb5ffe3e8d506aa61c85">calibrating</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classNoiseSource.html#a7ce647815524fe84f562aca5256e12f3">stir</a>() = 0;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classNoiseSource.html#a1af7449a5ae4a8acd34ac218c9eec6c1">output</a>(<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> len, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> credit);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;};</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classNoiseSource.html#a48d0efabd71ff6e557a0898be79c49ba">added</a>();</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;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classNoiseSource.html#a1af7449a5ae4a8acd34ac218c9eec6c1">output</a>(<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> len, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> credit);</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="preprocessor">#endif</span></div>
<div class="ttc" id="classNoiseSource_html_a601479b7d8cc215f97f2f8a18d3ef4c2"><div class="ttname"><a href="classNoiseSource.html#a601479b7d8cc215f97f2f8a18d3ef4c2">NoiseSource::NoiseSource</a></div><div class="ttdeci">NoiseSource()</div><div class="ttdoc">Constructs a new random noise source. </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8cpp_source.html#l00036">NoiseSource.cpp:36</a></div></div>
<div class="ttc" id="classNoiseSource_html_a7ce647815524fe84f562aca5256e12f3"><div class="ttname"><a href="classNoiseSource.html#a7ce647815524fe84f562aca5256e12f3">NoiseSource::stir</a></div><div class="ttdeci">virtual void stir()=0</div><div class="ttdoc">Stirs entropy from this noise source into the global random number pool. </div></div>
<div class="ttc" id="classNoiseSource_html"><div class="ttname"><a href="classNoiseSource.html">NoiseSource</a></div><div class="ttdoc">Abstract base class for random noise sources. </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8h_source.html#l00029">NoiseSource.h:29</a></div></div>
<div class="ttc" id="classNoiseSource_html_a1af7449a5ae4a8acd34ac218c9eec6c1"><div class="ttname"><a href="classNoiseSource.html#a1af7449a5ae4a8acd34ac218c9eec6c1">NoiseSource::output</a></div><div class="ttdeci">virtual void output(const uint8_t *data, size_t len, unsigned int credit)</div><div class="ttdoc">Called from subclasses to output noise to the global random number pool. </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8cpp_source.html#l00102">NoiseSource.cpp:102</a></div></div>
<div class="ttc" id="classNoiseSource_html_a48d0efabd71ff6e557a0898be79c49ba"><div class="ttname"><a href="classNoiseSource.html#a48d0efabd71ff6e557a0898be79c49ba">NoiseSource::added</a></div><div class="ttdeci">virtual void added()</div><div class="ttdoc">Called when the noise source is added to RNG with RNG.addNoiseSource(). </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8cpp_source.html#l00095">NoiseSource.cpp:95</a></div></div>
<div class="ttc" id="classNoiseSource_html_a1af7449a5ae4a8acd34ac218c9eec6c1"><div class="ttname"><a href="classNoiseSource.html#a1af7449a5ae4a8acd34ac218c9eec6c1">NoiseSource::output</a></div><div class="ttdeci">virtual void output(const uint8_t *data, size_t len, unsigned int credit)</div><div class="ttdoc">Called from subclasses to output noise to the global random number pool. </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8cpp_source.html#l00117">NoiseSource.cpp:117</a></div></div>
<div class="ttc" id="classNoiseSource_html_a4eca1e894a5d719fb9bf4df34a791cdb"><div class="ttname"><a href="classNoiseSource.html#a4eca1e894a5d719fb9bf4df34a791cdb">NoiseSource::~NoiseSource</a></div><div class="ttdeci">virtual ~NoiseSource()</div><div class="ttdoc">Destroys this random noise source. </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8cpp_source.html#l00043">NoiseSource.cpp:43</a></div></div>
<div class="ttc" id="classNoiseSource_html_ac8ac086f830efb5ffe3e8d506aa61c85"><div class="ttname"><a href="classNoiseSource.html#ac8ac086f830efb5ffe3e8d506aa61c85">NoiseSource::calibrating</a></div><div class="ttdeci">virtual bool calibrating() const =0</div><div class="ttdoc">Determine if the noise source is still calibrating itself. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 1 2015 16:36:10 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Apr 2 2015 16:36:51 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>