| <!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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Avro C++: avro::GenericUnion 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="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="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Avro C++ |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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="namespaceavro.html">avro</a></li><li class="navelem"><a class="el" href="classavro_1_1GenericUnion.html">GenericUnion</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classavro_1_1GenericUnion-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">avro::GenericUnion Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Generic container for unions. |
| <a href="classavro_1_1GenericUnion.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="GenericDatum_8hh_source.html">GenericDatum.hh</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for avro::GenericUnion:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classavro_1_1GenericUnion.png" usemap="#avro::GenericUnion_map" alt=""/> |
| <map id="avro::GenericUnion_map" name="avro::GenericUnion_map"> |
| <area href="classavro_1_1GenericContainer.html" title="The base class for all generic type for containers. " alt="avro::GenericContainer" shape="rect" coords="0,0,144,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:a29a00498e168284778c0e782e385e968"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericUnion.html#a29a00498e168284778c0e782e385e968">GenericUnion</a> (const NodePtr &<a class="el" href="classavro_1_1GenericContainer.html#a2d34ae4fc2ceb52885511ebc332361d3">schema</a>)</td></tr> |
| <tr class="memdesc:a29a00498e168284778c0e782e385e968"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a generic union corresponding to the given schema <code>schema</code>, and the given value. <a href="#a29a00498e168284778c0e782e385e968">More...</a><br /></td></tr> |
| <tr class="separator:a29a00498e168284778c0e782e385e968"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a97b5f0a1aaffc36fa8797a17cf8abe0f"><td class="memItemLeft" align="right" valign="top"><a id="a97b5f0a1aaffc36fa8797a17cf8abe0f"></a> |
| size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericUnion.html#a97b5f0a1aaffc36fa8797a17cf8abe0f">currentBranch</a> () const</td></tr> |
| <tr class="memdesc:a97b5f0a1aaffc36fa8797a17cf8abe0f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the current branch. <br /></td></tr> |
| <tr class="separator:a97b5f0a1aaffc36fa8797a17cf8abe0f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3568de30ef5ae41f5edfb7c6112929aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericUnion.html#a3568de30ef5ae41f5edfb7c6112929aa">selectBranch</a> (size_t branch)</td></tr> |
| <tr class="memdesc:a3568de30ef5ae41f5edfb7c6112929aa"><td class="mdescLeft"> </td><td class="mdescRight">Selects a new branch. <a href="#a3568de30ef5ae41f5edfb7c6112929aa">More...</a><br /></td></tr> |
| <tr class="separator:a3568de30ef5ae41f5edfb7c6112929aa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6d5e24f3a1123a2dba13bb3267610793"><td class="memItemLeft" align="right" valign="top"><a id="a6d5e24f3a1123a2dba13bb3267610793"></a> |
| <a class="el" href="classavro_1_1GenericDatum.html">GenericDatum</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericUnion.html#a6d5e24f3a1123a2dba13bb3267610793">datum</a> ()</td></tr> |
| <tr class="memdesc:a6d5e24f3a1123a2dba13bb3267610793"><td class="mdescLeft"> </td><td class="mdescRight">Returns the datum corresponding to the currently selected branch in this union. <br /></td></tr> |
| <tr class="separator:a6d5e24f3a1123a2dba13bb3267610793"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acbf23bb39585ac1d57f4efc481304300"><td class="memItemLeft" align="right" valign="top"><a id="acbf23bb39585ac1d57f4efc481304300"></a> |
| const <a class="el" href="classavro_1_1GenericDatum.html">GenericDatum</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericUnion.html#acbf23bb39585ac1d57f4efc481304300">datum</a> () const</td></tr> |
| <tr class="memdesc:acbf23bb39585ac1d57f4efc481304300"><td class="mdescLeft"> </td><td class="mdescRight">Returns the datum corresponding to the currently selected branch in this union. <br /></td></tr> |
| <tr class="separator:acbf23bb39585ac1d57f4efc481304300"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classavro_1_1GenericContainer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classavro_1_1GenericContainer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classavro_1_1GenericContainer.html">avro::GenericContainer</a></td></tr> |
| <tr class="memitem:a2d34ae4fc2ceb52885511ebc332361d3 inherit pub_methods_classavro_1_1GenericContainer"><td class="memItemLeft" align="right" valign="top"><a id="a2d34ae4fc2ceb52885511ebc332361d3"></a> |
| const NodePtr & </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericContainer.html#a2d34ae4fc2ceb52885511ebc332361d3">schema</a> () const</td></tr> |
| <tr class="memdesc:a2d34ae4fc2ceb52885511ebc332361d3 inherit pub_methods_classavro_1_1GenericContainer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the schema for this object. <br /></td></tr> |
| <tr class="separator:a2d34ae4fc2ceb52885511ebc332361d3 inherit pub_methods_classavro_1_1GenericContainer"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pro_methods_classavro_1_1GenericContainer"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classavro_1_1GenericContainer')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classavro_1_1GenericContainer.html">avro::GenericContainer</a></td></tr> |
| <tr class="memitem:abd0076ffe0a8e8f1fa531a524adeb5e2 inherit pro_methods_classavro_1_1GenericContainer"><td class="memItemLeft" align="right" valign="top"><a id="abd0076ffe0a8e8f1fa531a524adeb5e2"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericContainer.html#abd0076ffe0a8e8f1fa531a524adeb5e2">GenericContainer</a> (<a class="el" href="namespaceavro.html#a29e528c3fe1cb5660067a02721fae0b7">Type</a> type, const NodePtr &s)</td></tr> |
| <tr class="memdesc:abd0076ffe0a8e8f1fa531a524adeb5e2 inherit pro_methods_classavro_1_1GenericContainer"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a container corresponding to the given schema. <br /></td></tr> |
| <tr class="separator:abd0076ffe0a8e8f1fa531a524adeb5e2 inherit pro_methods_classavro_1_1GenericContainer"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Generic container for unions. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a29a00498e168284778c0e782e385e968"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a29a00498e168284778c0e782e385e968">◆ </a></span>GenericUnion()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">avro::GenericUnion::GenericUnion </td> |
| <td>(</td> |
| <td class="paramtype">const NodePtr & </td> |
| <td class="paramname"><em>schema</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>Constructs a generic union corresponding to the given schema <code>schema</code>, and the given value. </p> |
| <p>The schema should be of Avro type union and the value should correspond to one of the branches of the union. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a3568de30ef5ae41f5edfb7c6112929aa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3568de30ef5ae41f5edfb7c6112929aa">◆ </a></span>selectBranch()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void avro::GenericUnion::selectBranch </td> |
| <td>(</td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>branch</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>Selects a new branch. </p> |
| <p>The type for the value is changed accordingly. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">branch</td><td>The index for the selected branch. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>api/<a class="el" href="GenericDatum_8hh_source.html">GenericDatum.hh</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
