| <!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: scalar</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_1scalar.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="#related">Related Functions</a> | |
| <a href="classproton_1_1scalar-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">scalar</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A holder for an instance of any scalar AMQP type. |
| <a href="classproton_1_1scalar.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="scalar_8hpp_source.html">scalar.hpp</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for scalar:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classproton_1_1scalar.png" usemap="#scalar_map" alt=""/> |
| <map id="scalar_map" name="scalar_map"> |
| <area href="classproton_1_1scalar__base.html" title="The base class for scalar types." alt="scalar_base" shape="rect" coords="0,56,171,80"/> |
| </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:a79453d11d5d0a0ab021762a68a73d97e"><td class="memItemLeft" align="right" valign="top"><a id="a79453d11d5d0a0ab021762a68a73d97e"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar.html#a79453d11d5d0a0ab021762a68a73d97e">scalar</a> ()</td></tr> |
| <tr class="memdesc:a79453d11d5d0a0ab021762a68a73d97e"><td class="mdescLeft"> </td><td class="mdescRight">Create an empty scalar. <br /></td></tr> |
| <tr class="separator:a79453d11d5d0a0ab021762a68a73d97e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a247e504774a50ea9baeb9330d459a486"><td class="memTemplParams" colspan="2"><a id="a247e504774a50ea9baeb9330d459a486"></a> |
| template<class T > </td></tr> |
| <tr class="memitem:a247e504774a50ea9baeb9330d459a486"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar.html#a247e504774a50ea9baeb9330d459a486">scalar</a> (const T &x)</td></tr> |
| <tr class="memdesc:a247e504774a50ea9baeb9330d459a486"><td class="mdescLeft"> </td><td class="mdescRight">Construct from any scalar type. <br /></td></tr> |
| <tr class="separator:a247e504774a50ea9baeb9330d459a486"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7166ca618a14fe7e669059cb2ebbdb8f"><td class="memTemplParams" colspan="2"><a id="a7166ca618a14fe7e669059cb2ebbdb8f"></a> |
| template<class T > </td></tr> |
| <tr class="memitem:a7166ca618a14fe7e669059cb2ebbdb8f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1scalar.html">scalar</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar.html#a7166ca618a14fe7e669059cb2ebbdb8f">operator=</a> (const T &x)</td></tr> |
| <tr class="memdesc:a7166ca618a14fe7e669059cb2ebbdb8f"><td class="mdescLeft"> </td><td class="mdescRight">Assign from any scalar type. <br /></td></tr> |
| <tr class="separator:a7166ca618a14fe7e669059cb2ebbdb8f"><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_1scalar.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr> |
| <tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft"> </td><td class="mdescRight">Clear the scalar, making it <a class="el" href="classproton_1_1scalar__base.html#a644718bb2fb240de962dc3c9a1fdf0dc" title="True if there is no value, i.e. type() == NULL_TYPE.">empty()</a>. <br /></td></tr> |
| <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classproton_1_1scalar__base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classproton_1_1scalar__base')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classproton_1_1scalar__base.html">scalar_base</a></td></tr> |
| <tr class="memitem:a89dd77b1757d854f49d49e379f8f9db8 inherit pub_methods_classproton_1_1scalar__base"><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_1scalar__base.html#a89dd77b1757d854f49d49e379f8f9db8">type</a> () const</td></tr> |
| <tr class="memdesc:a89dd77b1757d854f49d49e379f8f9db8 inherit pub_methods_classproton_1_1scalar__base"><td class="mdescLeft"> </td><td class="mdescRight">AMQP type of data stored in the scalar. <br /></td></tr> |
| <tr class="separator:a89dd77b1757d854f49d49e379f8f9db8 inherit pub_methods_classproton_1_1scalar__base"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a644718bb2fb240de962dc3c9a1fdf0dc inherit pub_methods_classproton_1_1scalar__base"><td class="memItemLeft" align="right" valign="top"><a id="a644718bb2fb240de962dc3c9a1fdf0dc"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar__base.html#a644718bb2fb240de962dc3c9a1fdf0dc">empty</a> () const</td></tr> |
| <tr class="memdesc:a644718bb2fb240de962dc3c9a1fdf0dc inherit pub_methods_classproton_1_1scalar__base"><td class="mdescLeft"> </td><td class="mdescRight">True if there is no value, i.e. <a class="el" href="classproton_1_1scalar__base.html#a89dd77b1757d854f49d49e379f8f9db8" title="AMQP type of data stored in the scalar.">type()</a> == NULL_TYPE. <br /></td></tr> |
| <tr class="separator:a644718bb2fb240de962dc3c9a1fdf0dc inherit pub_methods_classproton_1_1scalar__base"><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:a61968283b9e1fc067dcad67e9fe58f6a"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a61968283b9e1fc067dcad67e9fe58f6a"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar.html#a61968283b9e1fc067dcad67e9fe58f6a">get</a> (const <a class="el" href="classproton_1_1scalar.html">scalar</a> &s)</td></tr> |
| <tr class="memdesc:a61968283b9e1fc067dcad67e9fe58f6a"><td class="mdescLeft"> </td><td class="mdescRight">Get a contained value of type T. <a href="classproton_1_1scalar.html#a61968283b9e1fc067dcad67e9fe58f6a">More...</a><br /></td></tr> |
| <tr class="separator:a61968283b9e1fc067dcad67e9fe58f6a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a59517f5cda18ae5c612f0c760398fe1d"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a59517f5cda18ae5c612f0c760398fe1d"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar.html#a59517f5cda18ae5c612f0c760398fe1d">coerce</a> (const <a class="el" href="classproton_1_1scalar.html">scalar</a> &x)</td></tr> |
| <tr class="memdesc:a59517f5cda18ae5c612f0c760398fe1d"><td class="mdescLeft"> </td><td class="mdescRight">Coerce the contained value to type T. <a href="classproton_1_1scalar.html#a59517f5cda18ae5c612f0c760398fe1d">More...</a><br /></td></tr> |
| <tr class="separator:a59517f5cda18ae5c612f0c760398fe1d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a31eda8feb7c15956a8c9091737505789"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a31eda8feb7c15956a8c9091737505789"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar.html#a31eda8feb7c15956a8c9091737505789">coerce</a> (<a class="el" href="classproton_1_1scalar.html">scalar</a> &x)</td></tr> |
| <tr class="memdesc:a31eda8feb7c15956a8c9091737505789"><td class="mdescLeft"> </td><td class="mdescRight">Coerce the contained value to type T. <a href="classproton_1_1scalar.html#a31eda8feb7c15956a8c9091737505789">More...</a><br /></td></tr> |
| <tr class="separator:a31eda8feb7c15956a8c9091737505789"><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 an instance of any scalar AMQP type. </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="types_page.html">AMQP and C++ types</a> </dd></dl> |
| </div><h2 class="groupheader">Friends And Related Function Documentation</h2> |
| <a id="a61968283b9e1fc067dcad67e9fe58f6a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a61968283b9e1fc067dcad67e9fe58f6a">◆ </a></span>get()</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_1scalar.html">scalar</a> & </td> |
| <td class="paramname"><em>s</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> |
| |
| </div> |
| </div> |
| <a id="a59517f5cda18ae5c612f0c760398fe1d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a59517f5cda18ae5c612f0c760398fe1d">◆ </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_1scalar.html">scalar</a> & </td> |
| <td class="paramname"><em>x</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="a31eda8feb7c15956a8c9091737505789"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a31eda8feb7c15956a8c9091737505789">◆ </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">T coerce </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classproton_1_1scalar.html">scalar</a> & </td> |
| <td class="paramname"><em>x</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> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>proton/<a class="el" href="scalar_8hpp_source.html">scalar.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_1scalar.html">scalar</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> |
