| <!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.20"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Qpid Proton C++ API: value</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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function() { init_search(); }); |
| /* @license-end */ |
| </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">Qpid Proton C++ API |
|  <span id="projectnumber">0.32.0</span> |
| </div> |
| </td> |
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.svg" |
| 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.svg" alt=""/></a> |
| </span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.20 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classproton_1_1value.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- 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 class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#friends">Friends</a> | |
| <a href="#related">Related Functions</a> | |
| <a href="classproton_1_1value-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">value</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A holder for any AMQP value, simple or complex. |
| <a href="classproton_1_1value.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="value_8hpp_source.html">value.hpp</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for value:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classproton_1_1value.png" alt=""/> |
| </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:aefbfa229f1c9e1fc967bff724a010f9e"><td class="memItemLeft" align="right" valign="top"><a id="aefbfa229f1c9e1fc967bff724a010f9e"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#aefbfa229f1c9e1fc967bff724a010f9e">value</a> ()</td></tr> |
| <tr class="memdesc:aefbfa229f1c9e1fc967bff724a010f9e"><td class="mdescLeft"> </td><td class="mdescRight">Create a null value. <br /></td></tr> |
| <tr class="separator:aefbfa229f1c9e1fc967bff724a010f9e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae7acdea6863a3b5100b7ac9e0b4c73e1"><td class="memTemplParams" colspan="2"><a id="ae7acdea6863a3b5100b7ac9e0b4c73e1"></a> |
| template<class T > </td></tr> |
| <tr class="memitem:ae7acdea6863a3b5100b7ac9e0b4c73e1"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#ae7acdea6863a3b5100b7ac9e0b4c73e1">value</a> (const T &x, typename assignable< T >::<a class="el" href="classproton_1_1value.html#a89dd77b1757d854f49d49e379f8f9db8">type</a> *=0)</td></tr> |
| <tr class="memdesc:ae7acdea6863a3b5100b7ac9e0b4c73e1"><td class="mdescLeft"> </td><td class="mdescRight">Copy from any allowed type T. <br /></td></tr> |
| <tr class="separator:ae7acdea6863a3b5100b7ac9e0b4c73e1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad139f5042c366b09078f123f5621c156"><td class="memTemplParams" colspan="2"><a id="ad139f5042c366b09078f123f5621c156"></a> |
| template<class T > </td></tr> |
| <tr class="memitem:ad139f5042c366b09078f123f5621c156"><td class="memTemplItemLeft" align="right" valign="top">assignable< T, <a class="el" href="classproton_1_1value.html">value</a> & >::<a class="el" href="classproton_1_1value.html#a89dd77b1757d854f49d49e379f8f9db8">type</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#ad139f5042c366b09078f123f5621c156">operator=</a> (const T &x)</td></tr> |
| <tr class="memdesc:ad139f5042c366b09078f123f5621c156"><td class="mdescLeft"> </td><td class="mdescRight">Assign from any allowed type T. <br /></td></tr> |
| <tr class="separator:ad139f5042c366b09078f123f5621c156"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a89dd77b1757d854f49d49e379f8f9db8"><td class="memItemLeft" align="right" valign="top"><a id="a89dd77b1757d854f49d49e379f8f9db8"></a> |
| <a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9">type_id</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#a89dd77b1757d854f49d49e379f8f9db8">type</a> () const</td></tr> |
| <tr class="memdesc:a89dd77b1757d854f49d49e379f8f9db8"><td class="mdescLeft"> </td><td class="mdescRight">Get the type ID for the current value. <br /></td></tr> |
| <tr class="separator:a89dd77b1757d854f49d49e379f8f9db8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="memItemLeft" align="right" valign="top"><a id="a644718bb2fb240de962dc3c9a1fdf0dc"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#a644718bb2fb240de962dc3c9a1fdf0dc">empty</a> () const</td></tr> |
| <tr class="memdesc:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="mdescLeft"> </td><td class="mdescRight">True if the value is null. <br /></td></tr> |
| <tr class="separator:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top"><a id="ac8bb3912a3ce86b15842e79d0b421204"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr> |
| <tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft"> </td><td class="mdescRight">Reset the value to null/empty. <br /></td></tr> |
| <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr><td colspan="2"><div class="groupHeader">Copy a value</div></td></tr> |
| <tr class="memitem:a035d5cba647aad8df637622977f71c9a"><td class="memItemLeft" align="right" valign="top"><a id="a035d5cba647aad8df637622977f71c9a"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>value</b> (const <a class="el" href="classproton_1_1value.html">value</a> &)</td></tr> |
| <tr class="separator:a035d5cba647aad8df637622977f71c9a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af5045852a07a6387ae38bdf56845afe3"><td class="memItemLeft" align="right" valign="top"><a id="af5045852a07a6387ae38bdf56845afe3"></a> |
| <a class="el" href="classproton_1_1value.html">value</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classproton_1_1value.html">value</a> &)</td></tr> |
| <tr class="separator:af5045852a07a6387ae38bdf56845afe3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a02f2dec042b54453b7278dd98a4530f3"><td class="memItemLeft" align="right" valign="top"><a id="a02f2dec042b54453b7278dd98a4530f3"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>value</b> (<a class="el" href="classproton_1_1value.html">value</a> &&)</td></tr> |
| <tr class="separator:a02f2dec042b54453b7278dd98a4530f3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a71b7aa04ba51fa2316ae66418394c8a1"><td class="memItemLeft" align="right" valign="top"><a id="a71b7aa04ba51fa2316ae66418394c8a1"></a> |
| <a class="el" href="classproton_1_1value.html">value</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classproton_1_1value.html">value</a> &&)</td></tr> |
| <tr class="separator:a71b7aa04ba51fa2316ae66418394c8a1"><td class="memSeparator" colspan="2"> </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:afdde986e34571c6544abfdea9afdb658"><td class="memItemLeft" align="right" valign="top"><a id="afdde986e34571c6544abfdea9afdb658"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#afdde986e34571c6544abfdea9afdb658">swap</a> (<a class="el" href="classproton_1_1value.html">value</a> &, <a class="el" href="classproton_1_1value.html">value</a> &)</td></tr> |
| <tr class="memdesc:afdde986e34571c6544abfdea9afdb658"><td class="mdescLeft"> </td><td class="mdescRight">swap values <br /></td></tr> |
| <tr class="separator:afdde986e34571c6544abfdea9afdb658"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a70ee803fc7f2a505266e357e7c13aa18"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#a70ee803fc7f2a505266e357e7c13aa18">operator<<</a> (std::ostream &, const <a class="el" href="classproton_1_1value.html">value</a> &)</td></tr> |
| <tr class="memdesc:a70ee803fc7f2a505266e357e7c13aa18"><td class="mdescLeft"> </td><td class="mdescRight">If contained value is a scalar type T, print using operator<<(T) <a href="classproton_1_1value.html#a70ee803fc7f2a505266e357e7c13aa18">More...</a><br /></td></tr> |
| <tr class="separator:a70ee803fc7f2a505266e357e7c13aa18"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr><td colspan="2"><div class="groupHeader">Comparison operators</div></td></tr> |
| <tr class="memitem:a9090beb5d7788f060fb0614b81c300ea"><td class="memItemLeft" align="right" valign="top"><a id="a9090beb5d7788f060fb0614b81c300ea"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classproton_1_1value.html">value</a> &x, const <a class="el" href="classproton_1_1value.html">value</a> &y)</td></tr> |
| <tr class="separator:a9090beb5d7788f060fb0614b81c300ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7e5a61eb2bd8cc8566cb4f231c020a23"><td class="memItemLeft" align="right" valign="top"><a id="a7e5a61eb2bd8cc8566cb4f231c020a23"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>operator<</b> (const <a class="el" href="classproton_1_1value.html">value</a> &x, const <a class="el" href="classproton_1_1value.html">value</a> &y)</td></tr> |
| <tr class="separator:a7e5a61eb2bd8cc8566cb4f231c020a23"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a> |
| Related Functions</h2></td></tr> |
| <tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p> |
| </td></tr> |
| <tr class="memitem:a051c12c4c7efc82a5f268d4f64e15b54"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a051c12c4c7efc82a5f268d4f64e15b54"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#a051c12c4c7efc82a5f268d4f64e15b54">get</a> (const <a class="el" href="classproton_1_1value.html">value</a> &v)</td></tr> |
| <tr class="memdesc:a051c12c4c7efc82a5f268d4f64e15b54"><td class="mdescLeft"> </td><td class="mdescRight">Get a contained value of type T. <a href="classproton_1_1value.html#a051c12c4c7efc82a5f268d4f64e15b54">More...</a><br /></td></tr> |
| <tr class="separator:a051c12c4c7efc82a5f268d4f64e15b54"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2dd4c0151b171f03f2c36d907832522b"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a2dd4c0151b171f03f2c36d907832522b"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#a2dd4c0151b171f03f2c36d907832522b">get</a> (const <a class="el" href="classproton_1_1value.html">value</a> &v, T &x)</td></tr> |
| <tr class="memdesc:a2dd4c0151b171f03f2c36d907832522b"><td class="mdescLeft"> </td><td class="mdescRight">Like <a class="el" href="classproton_1_1value.html#a051c12c4c7efc82a5f268d4f64e15b54" title="Get a contained value of type T.">get(const value&)</a> but extracts the value to a reference <code>x</code> instead of returning it. <a href="classproton_1_1value.html#a2dd4c0151b171f03f2c36d907832522b">More...</a><br /></td></tr> |
| <tr class="separator:a2dd4c0151b171f03f2c36d907832522b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adeafce6ab9aa5025c0fb82be5e81f922"><td class="memTemplParams" colspan="2"><a id="adeafce6ab9aa5025c0fb82be5e81f922"></a> |
| template<class T , class U > </td></tr> |
| <tr class="memitem:adeafce6ab9aa5025c0fb82be5e81f922"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>get</b> (const U &u, T &x)</td></tr> |
| <tr class="separator:adeafce6ab9aa5025c0fb82be5e81f922"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a486dfed974ca6f79e75039b3eee6c44c"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a486dfed974ca6f79e75039b3eee6c44c"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#a486dfed974ca6f79e75039b3eee6c44c">coerce</a> (const <a class="el" href="classproton_1_1value.html">value</a> &v)</td></tr> |
| <tr class="memdesc:a486dfed974ca6f79e75039b3eee6c44c"><td class="mdescLeft"> </td><td class="mdescRight">Coerce the contained value to type T. <a href="classproton_1_1value.html#a486dfed974ca6f79e75039b3eee6c44c">More...</a><br /></td></tr> |
| <tr class="separator:a486dfed974ca6f79e75039b3eee6c44c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4896ec87beab7d691e1985c221c36e49"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a4896ec87beab7d691e1985c221c36e49"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html#a4896ec87beab7d691e1985c221c36e49">coerce</a> (const <a class="el" href="classproton_1_1value.html">value</a> &v, T &x)</td></tr> |
| <tr class="memdesc:a4896ec87beab7d691e1985c221c36e49"><td class="mdescLeft"> </td><td class="mdescRight">Like <a class="el" href="classproton_1_1value.html#a486dfed974ca6f79e75039b3eee6c44c" title="Coerce the contained value to type T.">coerce(const value&)</a> but assigns the value to a reference instead of returning it. <a href="classproton_1_1value.html#a4896ec87beab7d691e1985c221c36e49">More...</a><br /></td></tr> |
| <tr class="separator:a4896ec87beab7d691e1985c221c36e49"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A holder for any AMQP value, simple or complex. </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="types_page.html">AMQP and C++ types</a> </dd></dl> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="service_bus_8cpp-example.html#_a6">service_bus.cpp</a>.</dd> |
| </dl> |
| </div><h2 class="groupheader">Friends And Related Function Documentation</h2> |
| <a id="a70ee803fc7f2a505266e357e7c13aa18"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a70ee803fc7f2a505266e357e7c13aa18">◆ </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">std::ostream& operator<< </td> |
| <td>(</td> |
| <td class="paramtype">std::ostream & </td> |
| <td class="paramname">, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classproton_1_1value.html">value</a> & </td> |
| <td class="paramname"> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>If contained value is a scalar type T, print using operator<<(T) </p> |
| <p>Complex types are printed in a non-standard human-readable format but that may change in future so should not be parsed. </p> |
| |
| </div> |
| </div> |
| <a id="a051c12c4c7efc82a5f268d4f64e15b54"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a051c12c4c7efc82a5f268d4f64e15b54">◆ </a></span>get() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T get </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classproton_1_1value.html">value</a> & </td> |
| <td class="paramname"><em>v</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">related</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get a contained value of type T. </p> |
| <p>For example: </p><pre class="fragment"> uint64_t i = get<uint64_t>(x) |
| </pre><p>This will succeed if and only if x contains a uint64_t value.</p> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="structproton_1_1conversion__error.html" title="An error converting between AMQP and C++ data.">conversion_error</a></td><td>if contained value is not of type T. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="service_bus_8cpp-example.html#a19">service_bus.cpp</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a2dd4c0151b171f03f2c36d907832522b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2dd4c0151b171f03f2c36d907832522b">◆ </a></span>get() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void get </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classproton_1_1value.html">value</a> & </td> |
| <td class="paramname"><em>v</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">T & </td> |
| <td class="paramname"><em>x</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">related</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Like <a class="el" href="classproton_1_1value.html#a051c12c4c7efc82a5f268d4f64e15b54" title="Get a contained value of type T.">get(const value&)</a> but extracts the value to a reference <code>x</code> instead of returning it. </p> |
| <p>May be more efficient for complex values (arrays, maps, etc.) </p> |
| |
| </div> |
| </div> |
| <a id="a486dfed974ca6f79e75039b3eee6c44c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a486dfed974ca6f79e75039b3eee6c44c">◆ </a></span>coerce() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T coerce </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classproton_1_1value.html">value</a> & </td> |
| <td class="paramname"><em>v</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">related</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Coerce the contained value to type T. </p> |
| <p>For example: </p><pre class="fragment"> uint64_t i = coerce<uint64_t>(x) |
| </pre><p>This will succeed if x contains any numeric value, but may lose precision if it contains a float or double value.</p> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="structproton_1_1conversion__error.html" title="An error converting between AMQP and C++ data.">conversion_error</a></td><td>if the value cannot be converted to T according to <code>std::is_convertible</code> </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a4896ec87beab7d691e1985c221c36e49"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4896ec87beab7d691e1985c221c36e49">◆ </a></span>coerce() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void coerce </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classproton_1_1value.html">value</a> & </td> |
| <td class="paramname"><em>v</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">T & </td> |
| <td class="paramname"><em>x</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">related</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Like <a class="el" href="classproton_1_1value.html#a486dfed974ca6f79e75039b3eee6c44c" title="Coerce the contained value to type T.">coerce(const value&)</a> but assigns the value to a reference instead of returning it. </p> |
| <p>May be more efficient for complex values (arrays, maps, etc.) </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>proton/<a class="el" href="value_8hpp_source.html">value.hpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="classproton_1_1value.html">value</a></li> |
| <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
