blob: dacc48531ff6ac049bc143c0b5e19e3a33c273ea [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::binary::BinaryObject 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="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="namespaceignite_1_1binary.html">binary</a></li><li class="navelem"><a class="el" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</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_1binary_1_1BinaryObject-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::binary::BinaryObject Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Binary object.
<a href="classignite_1_1binary_1_1BinaryObject.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="binary__object_8h_source.html">binary_object.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:a33e2264ff8c984c59b5578b8d285af68"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryObject.html#a33e2264ff8c984c59b5578b8d285af68">BinaryObject</a> (const <a class="el" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a> &amp;other)</td></tr>
<tr class="memdesc:a33e2264ff8c984c59b5578b8d285af68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="classignite_1_1binary_1_1BinaryObject.html#a33e2264ff8c984c59b5578b8d285af68">More...</a><br /></td></tr>
<tr class="separator:a33e2264ff8c984c59b5578b8d285af68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af334348d8a3dfa3524d5e671c6a256ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryObject.html#af334348d8a3dfa3524d5e671c6a256ca">operator=</a> (const <a class="el" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a> &amp;other)</td></tr>
<tr class="memdesc:af334348d8a3dfa3524d5e671c6a256ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <a href="classignite_1_1binary_1_1BinaryObject.html#af334348d8a3dfa3524d5e671c6a256ca">More...</a><br /></td></tr>
<tr class="separator:af334348d8a3dfa3524d5e671c6a256ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6fec1748035deed676bb04942a0a7c1"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:aa6fec1748035deed676bb04942a0a7c1"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryObject.html#aa6fec1748035deed676bb04942a0a7c1">Deserialize</a> () const</td></tr>
<tr class="memdesc:aa6fec1748035deed676bb04942a0a7c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserialize object. <a href="classignite_1_1binary_1_1BinaryObject.html#aa6fec1748035deed676bb04942a0a7c1">More...</a><br /></td></tr>
<tr class="separator:aa6fec1748035deed676bb04942a0a7c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27cda9ca714886910ada1b62c76f59e4"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a27cda9ca714886910ada1b62c76f59e4"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryObject.html#a27cda9ca714886910ada1b62c76f59e4">GetField</a> (const char *name) const</td></tr>
<tr class="memdesc:a27cda9ca714886910ada1b62c76f59e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get field. <a href="classignite_1_1binary_1_1BinaryObject.html#a27cda9ca714886910ada1b62c76f59e4">More...</a><br /></td></tr>
<tr class="separator:a27cda9ca714886910ada1b62c76f59e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a001112359409827867634b664666b524"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryObject.html#a001112359409827867634b664666b524">HasField</a> (const char *name) const</td></tr>
<tr class="memdesc:a001112359409827867634b664666b524"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the binary object has the specified field. <a href="classignite_1_1binary_1_1BinaryObject.html#a001112359409827867634b664666b524">More...</a><br /></td></tr>
<tr class="separator:a001112359409827867634b664666b524"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef2f18aab09a25c765bcc5687056b5d1"><td class="memItemLeft" align="right" valign="top"><a id="aef2f18aab09a25c765bcc5687056b5d1"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:aef2f18aab09a25c765bcc5687056b5d1"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>GetField</b> (const char *name) const</td></tr>
<tr class="separator:aef2f18aab09a25c765bcc5687056b5d1"><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:a91b0f94567b7dfcb426b8603a81c38fc"><td class="memItemLeft" align="right" valign="top"><a id="a91b0f94567b7dfcb426b8603a81c38fc"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>ignite::impl::binary::BinaryWriterImpl</b></td></tr>
<tr class="separator:a91b0f94567b7dfcb426b8603a81c38fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Binary object. </p>
<p>This is a thin wrapper over the memory area that contains serialized binary object. Provides method that allows deserialize object. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a33e2264ff8c984c59b5578b8d285af68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33e2264ff8c984c59b5578b8d285af68">&#9670;&nbsp;</a></span>BinaryObject()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ignite::binary::BinaryObject::BinaryObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a> &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>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa6fec1748035deed676bb04942a0a7c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6fec1748035deed676bb04942a0a7c1">&#9670;&nbsp;</a></span>Deserialize()</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">T ignite::binary::BinaryObject::Deserialize </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>Deserialize object. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a></td><td>if the object can not be deserialized to specified type.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Deserialized value. </dd></dl>
</div>
</div>
<a id="a27cda9ca714886910ada1b62c76f59e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27cda9ca714886910ada1b62c76f59e4">&#9670;&nbsp;</a></span>GetField()</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">T ignite::binary::BinaryObject::GetField </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em></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>Get field. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a></td><td>if the there is no specified field or if it is not of the specified type.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Field name. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Field value. </dd></dl>
</div>
</div>
<a id="a001112359409827867634b664666b524"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a001112359409827867634b664666b524">&#9670;&nbsp;</a></span>HasField()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ignite::binary::BinaryObject::HasField </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em></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 binary object has the specified field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Field name. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the binary object has the specified field and false otherwise. </dd></dl>
</div>
</div>
<a id="af334348d8a3dfa3524d5e671c6a256ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af334348d8a3dfa3524d5e671c6a256ca">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a>&amp; ignite::binary::BinaryObject::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a> &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>
<dl class="section return"><dt>Returns</dt><dd>*this. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="binary__object_8h_source.html">binary_object.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>