blob: 41506badb69d7fd5c60ffe9a2906137fb7f81534 [file] [log] [blame]
<!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>&nbsp; Apache Ignite C++: ignite::ConstReference&lt; T &gt; 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="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="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">&nbsp; Apache Ignite C++
</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"><a class="el" href="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="classignite_1_1ConstReference.html">ConstReference</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classignite_1_1ConstReference-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::ConstReference&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Constant <a class="el" href="classignite_1_1Reference.html" title="Reference class.">Reference</a> class.
<a href="classignite_1_1ConstReference.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="reference_8h_source.html">reference.h</a>&gt;</code></p>
<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:a63f63927e65aea9923eb6b207352d7e3"><td class="memItemLeft" align="right" valign="top"><a id="a63f63927e65aea9923eb6b207352d7e3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1ConstReference.html#a63f63927e65aea9923eb6b207352d7e3">ConstReference</a> ()</td></tr>
<tr class="memdesc:a63f63927e65aea9923eb6b207352d7e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a63f63927e65aea9923eb6b207352d7e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ea08f582e635a46f00a7c97f323118d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1ConstReference.html#a6ea08f582e635a46f00a7c97f323118d">ConstReference</a> (common::ConstReferenceImplBase *ptr, ptrdiff_t offset=0)</td></tr>
<tr class="memdesc:a6ea08f582e635a46f00a7c97f323118d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classignite_1_1ConstReference.html#a6ea08f582e635a46f00a7c97f323118d">More...</a><br /></td></tr>
<tr class="separator:a6ea08f582e635a46f00a7c97f323118d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95beded1e753e6d23535304d5c3c09ea"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1ConstReference.html#a95beded1e753e6d23535304d5c3c09ea">ConstReference</a> (const <a class="el" href="classignite_1_1ConstReference.html">ConstReference</a> &amp;other)</td></tr>
<tr class="memdesc:a95beded1e753e6d23535304d5c3c09ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="classignite_1_1ConstReference.html#a95beded1e753e6d23535304d5c3c09ea">More...</a><br /></td></tr>
<tr class="separator:a95beded1e753e6d23535304d5c3c09ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9d8957625a01e494bf2d931c84a0bbb"><td class="memTemplParams" colspan="2">template&lt;typename T2 &gt; </td></tr>
<tr class="memitem:ab9d8957625a01e494bf2d931c84a0bbb"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1ConstReference.html#ab9d8957625a01e494bf2d931c84a0bbb">ConstReference</a> (const <a class="el" href="classignite_1_1ConstReference.html">ConstReference</a>&lt; T2 &gt; &amp;other)</td></tr>
<tr class="memdesc:ab9d8957625a01e494bf2d931c84a0bbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="classignite_1_1ConstReference.html#ab9d8957625a01e494bf2d931c84a0bbb">More...</a><br /></td></tr>
<tr class="separator:ab9d8957625a01e494bf2d931c84a0bbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32b372113f08ffa0bd798613dd7bef8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1ConstReference.html">ConstReference</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1ConstReference.html#a32b372113f08ffa0bd798613dd7bef8e">operator=</a> (const <a class="el" href="classignite_1_1ConstReference.html">ConstReference</a> &amp;other)</td></tr>
<tr class="memdesc:a32b372113f08ffa0bd798613dd7bef8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <a href="classignite_1_1ConstReference.html#a32b372113f08ffa0bd798613dd7bef8e">More...</a><br /></td></tr>
<tr class="separator:a32b372113f08ffa0bd798613dd7bef8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a407552c66ea32aa700e6523832f6efb6"><td class="memTemplParams" colspan="2">template&lt;typename T2 &gt; </td></tr>
<tr class="memitem:a407552c66ea32aa700e6523832f6efb6"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1ConstReference.html">ConstReference</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1ConstReference.html#a407552c66ea32aa700e6523832f6efb6">operator=</a> (const <a class="el" href="classignite_1_1ConstReference.html">ConstReference</a>&lt; T2 &gt; &amp;other)</td></tr>
<tr class="memdesc:a407552c66ea32aa700e6523832f6efb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <a href="classignite_1_1ConstReference.html#a407552c66ea32aa700e6523832f6efb6">More...</a><br /></td></tr>
<tr class="separator:a407552c66ea32aa700e6523832f6efb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8969e0b386401978058310d6dc2a126f"><td class="memItemLeft" align="right" valign="top"><a id="a8969e0b386401978058310d6dc2a126f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1ConstReference.html#a8969e0b386401978058310d6dc2a126f">~ConstReference</a> ()</td></tr>
<tr class="memdesc:a8969e0b386401978058310d6dc2a126f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a8969e0b386401978058310d6dc2a126f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ff20fefbae5153dfc47f17ab1869712"><td class="memItemLeft" align="right" valign="top">const T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1ConstReference.html#a1ff20fefbae5153dfc47f17ab1869712">Get</a> () const</td></tr>
<tr class="memdesc:a1ff20fefbae5153dfc47f17ab1869712"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dereference the pointer. <a href="classignite_1_1ConstReference.html#a1ff20fefbae5153dfc47f17ab1869712">More...</a><br /></td></tr>
<tr class="separator:a1ff20fefbae5153dfc47f17ab1869712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07618541039afaf1967b6edb4344801e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1ConstReference.html#a07618541039afaf1967b6edb4344801e">IsNull</a> () const</td></tr>
<tr class="memdesc:a07618541039afaf1967b6edb4344801e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the pointer is null. <a href="classignite_1_1ConstReference.html#a07618541039afaf1967b6edb4344801e">More...</a><br /></td></tr>
<tr class="separator:a07618541039afaf1967b6edb4344801e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a7aaef6ece6e3d6910d5919fa1544a99a"><td class="memTemplParams" colspan="2"><a id="a7aaef6ece6e3d6910d5919fa1544a99a"></a>
template&lt;typename &gt; </td></tr>
<tr class="memitem:a7aaef6ece6e3d6910d5919fa1544a99a"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Reference</b></td></tr>
<tr class="separator:a7aaef6ece6e3d6910d5919fa1544a99a"><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;typename T&gt;<br />
class ignite::ConstReference&lt; T &gt;</h3>
<p>Constant <a class="el" href="classignite_1_1Reference.html" title="Reference class.">Reference</a> class. </p>
<p>Abstraction on any reference-type object, from simple raw pointers and references to standard library smart pointers. Provides only constant access to the underlying data.</p>
<p>There are no requirements for the template type T. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6ea08f582e635a46f00a7c97f323118d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ea08f582e635a46f00a7c97f323118d">&#9670;&nbsp;</a></span>ConstReference() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1ConstReference.html">ignite::ConstReference</a>&lt; T &gt;::<a class="el" href="classignite_1_1ConstReference.html">ConstReference</a> </td>
<td>(</td>
<td class="paramtype">common::ConstReferenceImplBase *&#160;</td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ptrdiff_t&#160;</td>
<td class="paramname"><em>offset</em> = <code>0</code>&#160;</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 class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td><a class="el" href="classignite_1_1ConstReference.html" title="Constant Reference class.">ConstReference</a> class implementation. </td></tr>
<tr><td class="paramname">offset</td><td>Pointer offset. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a95beded1e753e6d23535304d5c3c09ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95beded1e753e6d23535304d5c3c09ea">&#9670;&nbsp;</a></span>ConstReference() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1ConstReference.html">ignite::ConstReference</a>&lt; T &gt;::<a class="el" href="classignite_1_1ConstReference.html">ConstReference</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1ConstReference.html">ConstReference</a>&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>other</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>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab9d8957625a01e494bf2d931c84a0bbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9d8957625a01e494bf2d931c84a0bbb">&#9670;&nbsp;</a></span>ConstReference() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<div class="memtemplate">
template&lt;typename T2 &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1ConstReference.html">ignite::ConstReference</a>&lt; T &gt;::<a class="el" href="classignite_1_1ConstReference.html">ConstReference</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1ConstReference.html">ConstReference</a>&lt; T2 &gt; &amp;&#160;</td>
<td class="paramname"><em>other</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>Copy constructor. </p>
<p>Constant reference of type T2 should be static-castable to constant reference of type T.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1ff20fefbae5153dfc47f17ab1869712"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ff20fefbae5153dfc47f17ab1869712">&#9670;&nbsp;</a></span>Get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const T* <a class="el" href="classignite_1_1ConstReference.html">ignite::ConstReference</a>&lt; T &gt;::Get </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">
<p>Dereference the pointer. </p>
<p>If the pointer is null then this operation causes undefined behaviour.</p>
<dl class="section return"><dt>Returns</dt><dd>Constant reference to underlying value. </dd></dl>
</div>
</div>
<a id="a07618541039afaf1967b6edb4344801e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07618541039afaf1967b6edb4344801e">&#9670;&nbsp;</a></span>IsNull()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classignite_1_1ConstReference.html">ignite::ConstReference</a>&lt; T &gt;::IsNull </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">
<p>Check if the pointer is null. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the value is null. </dd></dl>
</div>
</div>
<a id="a32b372113f08ffa0bd798613dd7bef8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32b372113f08ffa0bd798613dd7bef8e">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1ConstReference.html">ConstReference</a>&amp; <a class="el" href="classignite_1_1ConstReference.html">ignite::ConstReference</a>&lt; T &gt;::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1ConstReference.html">ConstReference</a>&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>other</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>Assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a407552c66ea32aa700e6523832f6efb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a407552c66ea32aa700e6523832f6efb6">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<div class="memtemplate">
template&lt;typename T2 &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1ConstReference.html">ConstReference</a>&amp; <a class="el" href="classignite_1_1ConstReference.html">ignite::ConstReference</a>&lt; T &gt;::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1ConstReference.html">ConstReference</a>&lt; T2 &gt; &amp;&#160;</td>
<td class="paramname"><em>other</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>Assignment operator. </p>
<p>Constant reference of type T2 should be static-castable to constant reference of type T.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="reference_8h_source.html">reference.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 10 2022 11:02:04 for &nbsp; Apache Ignite C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>