blob: 5fde526f242e9842874c8be70be48809ff59fc3f [file] [log] [blame]
<!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>
<link rel="canonical" href="https://ignite.apache.org/releases/2.5.0/cppdoc/classignite_1_1ConstReference.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<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.11"/>
<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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<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','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></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.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</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 class="anchor" 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="#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="#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="#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="#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="#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 class="anchor" 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:a1328b74243e12ccddd0fdbc2b81ebe88"><td class="memItemLeft" align="right" valign="top">const T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1ConstReference.html#a1328b74243e12ccddd0fdbc2b81ebe88">Get</a> () const </td></tr>
<tr class="memdesc:a1328b74243e12ccddd0fdbc2b81ebe88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dereference the pointer. <a href="#a1328b74243e12ccddd0fdbc2b81ebe88">More...</a><br /></td></tr>
<tr class="separator:a1328b74243e12ccddd0fdbc2b81ebe88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab23dcbb1d85082d3e51f8e21cff45bff"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1ConstReference.html#ab23dcbb1d85082d3e51f8e21cff45bff">IsNull</a> () const </td></tr>
<tr class="memdesc:ab23dcbb1d85082d3e51f8e21cff45bff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the pointer is null. <a href="#ab23dcbb1d85082d3e51f8e21cff45bff">More...</a><br /></td></tr>
<tr class="separator:ab23dcbb1d85082d3e51f8e21cff45bff"><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:ab2c55e7aa5fe57077e40bf1007ab6968"><td class="memTemplParams" colspan="2"><a class="anchor" id="ab2c55e7aa5fe57077e40bf1007ab6968"></a>
template&lt;typename &gt; </td></tr>
<tr class="memitem:ab2c55e7aa5fe57077e40bf1007ab6968"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><b>ConstReference</b></td></tr>
<tr class="separator:ab2c55e7aa5fe57077e40bf1007ab6968"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7aaef6ece6e3d6910d5919fa1544a99a"><td class="memTemplParams" colspan="2"><a class="anchor" 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 class="anchor" id="a6ea08f582e635a46f00a7c97f323118d"></a>
<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 class="anchor" id="a95beded1e753e6d23535304d5c3c09ea"></a>
<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 class="anchor" id="ab9d8957625a01e494bf2d931c84a0bbb"></a>
<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 class="anchor" id="a1328b74243e12ccddd0fdbc2b81ebe88"></a>
<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 class="anchor" id="ab23dcbb1d85082d3e51f8e21cff45bff"></a>
<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 class="anchor" id="a32b372113f08ffa0bd798613dd7bef8e"></a>
<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 class="anchor" id="a407552c66ea32aa700e6523832f6efb6"></a>
<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 Wed May 23 2018 17:47:00 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.11
</small></address>
</body>
</html>