CGNICO/Metahuman_DNA_Calibration
2
0
Fork 0
Code Issues 19 Pull Requests 1 Actions Packages Projects Releases 7 Wiki Activity
67ed4ad552
Metahuman_DNA_Calibration/docs/doxygen/build/html/structdnac_1_1Signature.html
Srdjan Milicev 44bb3ac31f generated documentation
2022-11-29 14:58:38 +01:00

257 lines
14 KiB
HTML
Raw 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">
<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.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DNA Calib: dnac::Signature&lt; Size &gt; Struct 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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">DNA Calib<span id="projectnumber">&#160;1.1</span>
</div>
<div id="projectbrief">Project brief</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacednac.html">dnac</a></li><li class="navelem"><a class="el" href="structdnac_1_1Signature.html">Signature</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structdnac_1_1Signature-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">dnac::Signature&lt; Size &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="dnacalib_2dna_2DNA_8h_source.html">DNA.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for dnac::Signature&lt; Size &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structdnac_1_1Signature__coll__graph.png" border="0" usemap="#adnac_1_1Signature_3_01Size_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="adnac_1_1Signature_3_01Size_01_4_coll__map" id="adnac_1_1Signature_3_01Size_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="5,5,168,112"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ab17499c147d9fd280c785623a229ab62"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnac_1_1Signature.html#ab17499c147d9fd280c785623a229ab62">SignatureValueType</a> = std::array&lt; char, Size &gt;</td></tr>
<tr class="separator:ab17499c147d9fd280c785623a229ab62"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a495ec861895f337eba5248ff8a62d219"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnac_1_1Signature.html#a495ec861895f337eba5248ff8a62d219">Signature</a> (<a class="el" href="structdnac_1_1Signature.html#ab17499c147d9fd280c785623a229ab62">SignatureValueType</a> bytes)</td></tr>
<tr class="separator:a495ec861895f337eba5248ff8a62d219"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a764595cc1dc4c919804a39dc5967b1cd"><td class="memTemplParams" colspan="2">template&lt;class Archive &gt; </td></tr>
<tr class="memitem:a764595cc1dc4c919804a39dc5967b1cd"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structdnac_1_1Signature.html#a764595cc1dc4c919804a39dc5967b1cd">serialize</a> (Archive &amp;archive)</td></tr>
<tr class="separator:a764595cc1dc4c919804a39dc5967b1cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61980581f501315e14f02df5dec6a792"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnac_1_1Signature.html#a61980581f501315e14f02df5dec6a792">matches</a> () const</td></tr>
<tr class="separator:a61980581f501315e14f02df5dec6a792"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:af52c91a011e1c55f36225927e79b65e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdnac_1_1ExpectedValue.html">ExpectedValue</a>&lt; <a class="el" href="structdnac_1_1Signature.html#ab17499c147d9fd280c785623a229ab62">SignatureValueType</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnac_1_1Signature.html#af52c91a011e1c55f36225927e79b65e1">value</a></td></tr>
<tr class="separator:af52c91a011e1c55f36225927e79b65e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ab17499c147d9fd280c785623a229ab62" name="ab17499c147d9fd280c785623a229ab62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab17499c147d9fd280c785623a229ab62">&#9670;&nbsp;</a></span>SignatureValueType</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;std::size_t Size&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structdnac_1_1Signature.html">dnac::Signature</a>&lt; Size &gt;::SignatureValueType = std::array&lt;char, Size&gt;</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a495ec861895f337eba5248ff8a62d219" name="a495ec861895f337eba5248ff8a62d219"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a495ec861895f337eba5248ff8a62d219">&#9670;&nbsp;</a></span>Signature()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;std::size_t Size&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structdnac_1_1Signature.html">dnac::Signature</a>&lt; Size &gt;::Signature </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdnac_1_1Signature.html#ab17499c147d9fd280c785623a229ab62">SignatureValueType</a>&#160;</td>
<td class="paramname"><em>bytes</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<div class="fragment"><div class="line"><span class="lineno"> 75</span> : <a class="code hl_variable" href="structdnac_1_1Signature.html#af52c91a011e1c55f36225927e79b65e1">value</a>{bytes} {</div>
<div class="line"><span class="lineno"> 76</span> }</div>
<div class="ttc" id="astructdnac_1_1Signature_html_af52c91a011e1c55f36225927e79b65e1"><div class="ttname"><a href="structdnac_1_1Signature.html#af52c91a011e1c55f36225927e79b65e1">dnac::Signature::value</a></div><div class="ttdeci">ExpectedValue&lt; SignatureValueType &gt; value</div><div class="ttdef"><b>Definition:</b> dnacalib/dna/DNA.h:73</div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a61980581f501315e14f02df5dec6a792" name="a61980581f501315e14f02df5dec6a792"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61980581f501315e14f02df5dec6a792">&#9670;&nbsp;</a></span>matches()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;std::size_t Size&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structdnac_1_1Signature.html">dnac::Signature</a>&lt; Size &gt;::matches </td>
<td>(</td>
<td class="paramname"></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">
<div class="fragment"><div class="line"><span class="lineno"> 84</span> {</div>
<div class="line"><span class="lineno"> 85</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="structdnac_1_1Signature.html#af52c91a011e1c55f36225927e79b65e1">value</a>.<a class="code hl_function" href="structdna_1_1ExpectedValue.html#abccd53a0e1a267829a7537a53dc38cd1">matches</a>();</div>
<div class="line"><span class="lineno"> 86</span> }</div>
<div class="ttc" id="astructdna_1_1ExpectedValue_html_abccd53a0e1a267829a7537a53dc38cd1"><div class="ttname"><a href="structdna_1_1ExpectedValue.html#abccd53a0e1a267829a7537a53dc38cd1">dna::ExpectedValue::matches</a></div><div class="ttdeci">bool matches() const</div><div class="ttdef"><b>Definition:</b> dna/DNA.h:63</div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="structdna_1_1ExpectedValue.html#abccd53a0e1a267829a7537a53dc38cd1">dna::ExpectedValue&lt; T &gt;::matches()</a>, and <a class="el" href="structdnac_1_1Signature.html#af52c91a011e1c55f36225927e79b65e1">dnac::Signature&lt; Size &gt;::value</a>.</p>
</div>
</div>
<a id="a764595cc1dc4c919804a39dc5967b1cd" name="a764595cc1dc4c919804a39dc5967b1cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a764595cc1dc4c919804a39dc5967b1cd">&#9670;&nbsp;</a></span>serialize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;std::size_t Size&gt; </div>
<div class="memtemplate">
template&lt;class Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structdnac_1_1Signature.html">dnac::Signature</a>&lt; Size &gt;::serialize </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</em></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 class="fragment"><div class="line"><span class="lineno"> 79</span> {</div>
<div class="line"><span class="lineno"> 80</span> archive.label(<span class="stringliteral">&quot;data&quot;</span>);</div>
<div class="line"><span class="lineno"> 81</span> archive(<a class="code hl_variable" href="structdnac_1_1Signature.html#af52c91a011e1c55f36225927e79b65e1">value</a>);</div>
<div class="line"><span class="lineno"> 82</span> }</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="structdnac_1_1Signature.html#af52c91a011e1c55f36225927e79b65e1">dnac::Signature&lt; Size &gt;::value</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af52c91a011e1c55f36225927e79b65e1" name="af52c91a011e1c55f36225927e79b65e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af52c91a011e1c55f36225927e79b65e1">&#9670;&nbsp;</a></span>value</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;std::size_t Size&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structdnac_1_1ExpectedValue.html">ExpectedValue</a>&lt;<a class="el" href="structdnac_1_1Signature.html#ab17499c147d9fd280c785623a229ab62">SignatureValueType</a>&gt; <a class="el" href="structdnac_1_1Signature.html">dnac::Signature</a>&lt; Size &gt;::value</td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="structdnac_1_1Signature.html#a61980581f501315e14f02df5dec6a792">dnac::Signature&lt; Size &gt;::matches()</a>, and <a class="el" href="structdnac_1_1Signature.html#a764595cc1dc4c919804a39dc5967b1cd">dnac::Signature&lt; Size &gt;::serialize()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="dnacalib_2dna_2DNA_8h_source.html">dnacalib/dna/DNA.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink