<!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=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Crypto++: ASNOptional< T > 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> <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="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Crypto++  <span id="projectnumber">7.0</span> </div> <div id="projectbrief">Free C++ class library of cryptographic schemes</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <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&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="class_a_s_n_optional-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">ASNOptional< T > Class Template Reference</div> </div> </div><!--header--> <div class="contents"> <p>Optional data encoder and decoder. <a href="class_a_s_n_optional.html#details">More...</a></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 ASNOptional< T >:</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="class_a_s_n_optional.png" usemap="#ASNOptional_3C_20T_20_3E_map" alt=""/> <map id="ASNOptional_3C_20T_20_3E_map" name="ASNOptional_3C_20T_20_3E_map"> <area href="classmember__ptr.html" title="Pointer that overloads operator ->" alt="member_ptr< T >" shape="rect" coords="0,0,116,24"/> </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:a4420b3319618c5e7e84686f1ce19d01d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_s_n_optional.html#a4420b3319618c5e7e84686f1ce19d01d">BERDecode</a> (<a class="el" href="class_b_e_r_sequence_decoder.html">BERSequenceDecoder</a> &seqDecoder, byte tag, byte mask=~CONSTRUCTED)</td></tr> <tr class="memdesc:a4420b3319618c5e7e84686f1ce19d01d"><td class="mdescLeft"> </td><td class="mdescRight">BER decode optional data. <a href="#a4420b3319618c5e7e84686f1ce19d01d">More...</a><br /></td></tr> <tr class="separator:a4420b3319618c5e7e84686f1ce19d01d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a36790c38b68ba5a91eafbf5b97bd3c14"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_s_n_optional.html#a36790c38b68ba5a91eafbf5b97bd3c14">DEREncode</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &out)</td></tr> <tr class="memdesc:a36790c38b68ba5a91eafbf5b97bd3c14"><td class="mdescLeft"> </td><td class="mdescRight">DER encode optional data. <a href="#a36790c38b68ba5a91eafbf5b97bd3c14">More...</a><br /></td></tr> <tr class="separator:a36790c38b68ba5a91eafbf5b97bd3c14"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classmember__ptr"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmember__ptr')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classmember__ptr.html">member_ptr< T ></a></td></tr> <tr class="memitem:a07de11b50740176cd87957cb3ed3d3b8 inherit pub_methods_classmember__ptr"><td class="memItemLeft" align="right" valign="top"><a id="a07de11b50740176cd87957cb3ed3d3b8"></a>  </td><td class="memItemRight" valign="bottom"><b>member_ptr</b> (T *p=NULL)</td></tr> <tr class="separator:a07de11b50740176cd87957cb3ed3d3b8 inherit pub_methods_classmember__ptr"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae555c277184e16ab673113648027bd21 inherit pub_methods_classmember__ptr"><td class="memItemLeft" align="right" valign="top"><a id="ae555c277184e16ab673113648027bd21"></a> const T & </td><td class="memItemRight" valign="bottom"><b>operator*</b> () const</td></tr> <tr class="separator:ae555c277184e16ab673113648027bd21 inherit pub_methods_classmember__ptr"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a79eefdcba17bcadd54dff9b3b4948937 inherit pub_methods_classmember__ptr"><td class="memItemLeft" align="right" valign="top"><a id="a79eefdcba17bcadd54dff9b3b4948937"></a> T & </td><td class="memItemRight" valign="bottom"><b>operator*</b> ()</td></tr> <tr class="separator:a79eefdcba17bcadd54dff9b3b4948937 inherit pub_methods_classmember__ptr"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af98d04ac57ff3a330394f4327aa805b1 inherit pub_methods_classmember__ptr"><td class="memItemLeft" align="right" valign="top"><a id="af98d04ac57ff3a330394f4327aa805b1"></a> const T * </td><td class="memItemRight" valign="bottom"><b>operator-></b> () const</td></tr> <tr class="separator:af98d04ac57ff3a330394f4327aa805b1 inherit pub_methods_classmember__ptr"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af129ccfbdb03a896c933bf5cd00c31b0 inherit pub_methods_classmember__ptr"><td class="memItemLeft" align="right" valign="top"><a id="af129ccfbdb03a896c933bf5cd00c31b0"></a> T * </td><td class="memItemRight" valign="bottom"><b>operator-></b> ()</td></tr> <tr class="separator:af129ccfbdb03a896c933bf5cd00c31b0 inherit pub_methods_classmember__ptr"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2d10dec2a51691b589d56b71ec78e59a inherit pub_methods_classmember__ptr"><td class="memItemLeft" align="right" valign="top"><a id="a2d10dec2a51691b589d56b71ec78e59a"></a> const T * </td><td class="memItemRight" valign="bottom"><b>get</b> () const</td></tr> <tr class="separator:a2d10dec2a51691b589d56b71ec78e59a inherit pub_methods_classmember__ptr"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae2feaf010df5dbe2ac54dc02ccb976ed inherit pub_methods_classmember__ptr"><td class="memItemLeft" align="right" valign="top"><a id="ae2feaf010df5dbe2ac54dc02ccb976ed"></a> T * </td><td class="memItemRight" valign="bottom"><b>get</b> ()</td></tr> <tr class="separator:ae2feaf010df5dbe2ac54dc02ccb976ed inherit pub_methods_classmember__ptr"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3e2476e6f94e4f472b1ae3cf26d94a16 inherit pub_methods_classmember__ptr"><td class="memItemLeft" align="right" valign="top"><a id="a3e2476e6f94e4f472b1ae3cf26d94a16"></a> T * </td><td class="memItemRight" valign="bottom"><b>release</b> ()</td></tr> <tr class="separator:a3e2476e6f94e4f472b1ae3cf26d94a16 inherit pub_methods_classmember__ptr"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0191c833924d93e9093b07bab31010fe inherit pub_methods_classmember__ptr"><td class="memItemLeft" align="right" valign="top"><a id="a0191c833924d93e9093b07bab31010fe"></a> void </td><td class="memItemRight" valign="bottom"><b>reset</b> (T *p=0)</td></tr> <tr class="separator:a0191c833924d93e9093b07bab31010fe inherit pub_methods_classmember__ptr"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<class T><br /> class ASNOptional< T ></h3> <p>Optional data encoder and decoder. </p> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> <tr><td class="paramname">T</td><td>class or type </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="asn_8h_source.html#l00347">347</a> of file <a class="el" href="asn_8h_source.html">asn.h</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="a4420b3319618c5e7e84686f1ce19d01d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a4420b3319618c5e7e84686f1ce19d01d">◆ </a></span>BERDecode()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void <a class="el" href="class_a_s_n_optional.html">ASNOptional</a>< T >::BERDecode </td> <td>(</td> <td class="paramtype"><a class="el" href="class_b_e_r_sequence_decoder.html">BERSequenceDecoder</a> & </td> <td class="paramname"><em>seqDecoder</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">byte </td> <td class="paramname"><em>tag</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">byte </td> <td class="paramname"><em>mask</em> = <code>~CONSTRUCTED</code> </td> </tr> <tr> <td></td> <td>)</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>BER decode optional data. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">seqDecoder</td><td>sequence with the optional ASN.1 data </td></tr> <tr><td class="paramname">tag</td><td>ASN.1 tag to match as optional data </td></tr> <tr><td class="paramname">mask</td><td>the mask to apply when matching the tag </td></tr> </table> </dd> </dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="asn_8h.html#adf2a7ad51c665c609abbb2dd71ad4a9d" title="ASN.1 types.">ASNTag</a> and <a class="el" href="asn_8h.html#a78a87342a75aedee779a1de3db486290" title="ASN.1 flags.">ASNIdFlag</a> </dd></dl> <p class="definition">Definition at line <a class="el" href="asn_8h_source.html#l00355">355</a> of file <a class="el" href="asn_8h_source.html">asn.h</a>.</p> </div> </div> <a id="a36790c38b68ba5a91eafbf5b97bd3c14"></a> <h2 class="memtitle"><span class="permalink"><a href="#a36790c38b68ba5a91eafbf5b97bd3c14">◆ </a></span>DEREncode()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void <a class="el" href="class_a_s_n_optional.html">ASNOptional</a>< T >::DEREncode </td> <td>(</td> <td class="paramtype"><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> & </td> <td class="paramname"><em>out</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"> <p>DER encode optional data. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">out</td><td><a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations.">BufferedTransformation</a> object </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="asn_8h_source.html#l00364">364</a> of file <a class="el" href="asn_8h_source.html">asn.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="asn_8h_source.html">asn.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Wed Nov 27 2019 15:03:54 for Crypto++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>