cereal/assets/doxygen/structcereal_1_1detail_1_1PolymorphicVirtualCaster.html
2022-02-27 19:48:38 -08:00

179 lines
13 KiB
HTML

<!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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>cereal: cereal::detail::PolymorphicVirtualCaster&lt; Base, Derived &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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">cereal
</div>
<div id="projectbrief">A C++11 library for serialization</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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>
<!-- 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"><b>cereal</b></li><li class="navelem"><b>detail</b></li><li class="navelem"><a class="el" href="structcereal_1_1detail_1_1PolymorphicVirtualCaster.html">PolymorphicVirtualCaster</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structcereal_1_1detail_1_1PolymorphicVirtualCaster-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cereal::detail::PolymorphicVirtualCaster&lt; Base, Derived &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Strongly typed derivation of <a class="el" href="structcereal_1_1detail_1_1PolymorphicCaster.html" title="Base type for polymorphic void casting.">PolymorphicCaster</a>.
<a href="structcereal_1_1detail_1_1PolymorphicVirtualCaster.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="polymorphic__impl_8hpp_source.html">/home/shane/workspace/cereal/include/cereal/details/polymorphic_impl.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for cereal::detail::PolymorphicVirtualCaster&lt; Base, Derived &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="structcereal_1_1detail_1_1PolymorphicVirtualCaster.png" usemap="#cereal::detail::PolymorphicVirtualCaster_3C_20Base_2C_20Derived_20_3E_map" alt=""/>
<map id="cereal::detail::PolymorphicVirtualCaster_3C_20Base_2C_20Derived_20_3E_map" name="cereal::detail::PolymorphicVirtualCaster_3C_20Base_2C_20Derived_20_3E_map">
<area href="structcereal_1_1detail_1_1PolymorphicCaster.html" title="Base type for polymorphic void casting." alt="cereal::detail::PolymorphicCaster" shape="rect" coords="0,0,340,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:a8bef2d14f5bb2d295263d41659c4f1f0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1detail_1_1PolymorphicVirtualCaster.html#a8bef2d14f5bb2d295263d41659c4f1f0">PolymorphicVirtualCaster</a> ()</td></tr>
<tr class="memdesc:a8bef2d14f5bb2d295263d41659c4f1f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inserts an entry in the polymorphic casting map for this pairing. <a href="structcereal_1_1detail_1_1PolymorphicVirtualCaster.html#a8bef2d14f5bb2d295263d41659c4f1f0">More...</a><br /></td></tr>
<tr class="separator:a8bef2d14f5bb2d295263d41659c4f1f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77434b14bd95cf53dc4218140682e399"><td class="memItemLeft" align="right" valign="top"><a id="a77434b14bd95cf53dc4218140682e399"></a>
const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1detail_1_1PolymorphicVirtualCaster.html#a77434b14bd95cf53dc4218140682e399">downcast</a> (void const *const ptr) const override</td></tr>
<tr class="memdesc:a77434b14bd95cf53dc4218140682e399"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs the proper downcast with the templated types. <br /></td></tr>
<tr class="separator:a77434b14bd95cf53dc4218140682e399"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad16c1ab78ccdcf8826ce707adc3fa969"><td class="memItemLeft" align="right" valign="top"><a id="ad16c1ab78ccdcf8826ce707adc3fa969"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1detail_1_1PolymorphicVirtualCaster.html#ad16c1ab78ccdcf8826ce707adc3fa969">upcast</a> (void *const ptr) const override</td></tr>
<tr class="memdesc:ad16c1ab78ccdcf8826ce707adc3fa969"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs the proper upcast with the templated types. <br /></td></tr>
<tr class="separator:ad16c1ab78ccdcf8826ce707adc3fa969"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7233787834faaab0ddec22437471aa96"><td class="memItemLeft" align="right" valign="top"><a id="a7233787834faaab0ddec22437471aa96"></a>
std::shared_ptr&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1detail_1_1PolymorphicVirtualCaster.html#a7233787834faaab0ddec22437471aa96">upcast</a> (std::shared_ptr&lt; void &gt; const &amp;ptr) const override</td></tr>
<tr class="memdesc:a7233787834faaab0ddec22437471aa96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs the proper upcast with the templated types (shared_ptr version) <br /></td></tr>
<tr class="separator:a7233787834faaab0ddec22437471aa96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structcereal_1_1detail_1_1PolymorphicCaster"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structcereal_1_1detail_1_1PolymorphicCaster')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structcereal_1_1detail_1_1PolymorphicCaster.html">cereal::detail::PolymorphicCaster</a></td></tr>
<tr class="memitem:a8e3e433a846520d1b2d315eb475d0ebc inherit pub_methods_structcereal_1_1detail_1_1PolymorphicCaster"><td class="memItemLeft" align="right" valign="top"><a id="a8e3e433a846520d1b2d315eb475d0ebc"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PolymorphicCaster</b> (const <a class="el" href="structcereal_1_1detail_1_1PolymorphicCaster.html">PolymorphicCaster</a> &amp;)=default</td></tr>
<tr class="separator:a8e3e433a846520d1b2d315eb475d0ebc inherit pub_methods_structcereal_1_1detail_1_1PolymorphicCaster"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ab9e81c3fc7efb5ef73f57b9932a64f inherit pub_methods_structcereal_1_1detail_1_1PolymorphicCaster"><td class="memItemLeft" align="right" valign="top"><a id="a6ab9e81c3fc7efb5ef73f57b9932a64f"></a>
<a class="el" href="structcereal_1_1detail_1_1PolymorphicCaster.html">PolymorphicCaster</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="structcereal_1_1detail_1_1PolymorphicCaster.html">PolymorphicCaster</a> &amp;)=default</td></tr>
<tr class="separator:a6ab9e81c3fc7efb5ef73f57b9932a64f inherit pub_methods_structcereal_1_1detail_1_1PolymorphicCaster"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07ee3977cf1b8cac4b087258e8d3a517 inherit pub_methods_structcereal_1_1detail_1_1PolymorphicCaster"><td class="memItemLeft" align="right" valign="top"><a id="a07ee3977cf1b8cac4b087258e8d3a517"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PolymorphicCaster</b> (<a class="el" href="structcereal_1_1detail_1_1PolymorphicCaster.html">PolymorphicCaster</a> &amp;&amp;) <a class="el" href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">CEREAL_NOEXCEPT</a></td></tr>
<tr class="separator:a07ee3977cf1b8cac4b087258e8d3a517 inherit pub_methods_structcereal_1_1detail_1_1PolymorphicCaster"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9783e7e27a7da70d7fa0fcc1f1883f50 inherit pub_methods_structcereal_1_1detail_1_1PolymorphicCaster"><td class="memItemLeft" align="right" valign="top"><a id="a9783e7e27a7da70d7fa0fcc1f1883f50"></a>
<a class="el" href="structcereal_1_1detail_1_1PolymorphicCaster.html">PolymorphicCaster</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="structcereal_1_1detail_1_1PolymorphicCaster.html">PolymorphicCaster</a> &amp;&amp;) <a class="el" href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">CEREAL_NOEXCEPT</a></td></tr>
<tr class="separator:a9783e7e27a7da70d7fa0fcc1f1883f50 inherit pub_methods_structcereal_1_1detail_1_1PolymorphicCaster"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Base, class Derived&gt;<br />
struct cereal::detail::PolymorphicVirtualCaster&lt; Base, Derived &gt;</h3>
<p>Strongly typed derivation of <a class="el" href="structcereal_1_1detail_1_1PolymorphicCaster.html" title="Base type for polymorphic void casting.">PolymorphicCaster</a>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8bef2d14f5bb2d295263d41659c4f1f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bef2d14f5bb2d295263d41659c4f1f0">&#9670;&nbsp;</a></span>PolymorphicVirtualCaster()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Base , class Derived &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcereal_1_1detail_1_1PolymorphicVirtualCaster.html">cereal::detail::PolymorphicVirtualCaster</a>&lt; Base, Derived &gt;::<a class="el" href="structcereal_1_1detail_1_1PolymorphicVirtualCaster.html">PolymorphicVirtualCaster</a> </td>
<td>(</td>
<td class="paramname"></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>Inserts an entry in the polymorphic casting map for this pairing. </p>
<p>Creates an explicit mapping between Base and Derived in both upwards and downwards directions, allowing void pointers to either to be properly cast assuming dynamic type information is available </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="polymorphic__impl_8hpp_source.html">polymorphic_impl.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.3.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 27 2022 19:46:46 for cereal by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-42360142-1', 'uscilab.github.io');
ga('send', 'pageview');
</script>
</body>
</html>