| <!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: proton/scalar.hpp Source File</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('scalar_8hpp_source.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="headertitle"> |
| <div class="title">scalar.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="scalar_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_SCALAR_HPP</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_SCALAR_HPP</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="scalar__base_8hpp.html">./scalar_base.hpp</a>"</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="null_8hpp.html">proton/null.hpp</a>"</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <proton/type_compat.h></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div> |
| <div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classproton_1_1scalar.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="classproton_1_1scalar.html">scalar</a> : <span class="keyword">public</span> <a class="code" href="classproton_1_1scalar__base.html">scalar_base</a> {</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classproton_1_1scalar.html#a79453d11d5d0a0ab021762a68a73d97e"> 40</a></span>  PN_CPP_EXTERN <a class="code" href="classproton_1_1scalar.html#a79453d11d5d0a0ab021762a68a73d97e">scalar</a>() {}</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div> |
| <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classproton_1_1scalar.html#a247e504774a50ea9baeb9330d459a486"> 43</a></span>  <span class="keyword">template</span> <<span class="keyword">class</span> T> <a class="code" href="classproton_1_1scalar.html#a247e504774a50ea9baeb9330d459a486">scalar</a>(<span class="keyword">const</span> T& x) { *<span class="keyword">this</span> = x; }</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classproton_1_1scalar.html#a7166ca618a14fe7e669059cb2ebbdb8f"> 46</a></span>  <span class="keyword">template</span> <<span class="keyword">class</span> T> <a class="code" href="classproton_1_1scalar.html">scalar</a>& <a class="code" href="classproton_1_1scalar.html#a7166ca618a14fe7e669059cb2ebbdb8f">operator=</a>(<span class="keyword">const</span> T& x) { put(x); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div> |
| <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classproton_1_1scalar.html#ac8bb3912a3ce86b15842e79d0b421204"> 49</a></span>  <span class="keywordtype">void</span> <a class="code" href="classproton_1_1scalar.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a>() { *<span class="keyword">this</span> = <span class="keyword">null</span>(); }</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> };</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div> |
| <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="namespaceproton.html#a61968283b9e1fc067dcad67e9fe58f6a"> 60</a></span> <span class="keyword">template</span><<span class="keyword">class</span> T> T <a class="code" href="namespaceproton.html#a61968283b9e1fc067dcad67e9fe58f6a">get</a>(<span class="keyword">const</span> <a class="code" href="classproton_1_1scalar.html">scalar</a>& s) { <span class="keywordflow">return</span> internal::get<T>(s); }</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div> |
| <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="namespaceproton.html#a59517f5cda18ae5c612f0c760398fe1d"> 72</a></span> <span class="keyword">template</span><<span class="keyword">class</span> T> T <a class="code" href="namespaceproton.html#ab73c44b530463fda5e11bc403ca9edd3">coerce</a>(<span class="keyword">const</span> <a class="code" href="classproton_1_1scalar.html">scalar</a>& x) { <span class="keywordflow">return</span> internal::coerce<T>(x); }</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="namespaceproton.html#a31eda8feb7c15956a8c9091737505789"> 85</a></span> <span class="keyword">template</span><<span class="keyword">class</span> T> T <a class="code" href="namespaceproton.html#ab73c44b530463fda5e11bc403ca9edd3">coerce</a>(<a class="code" href="classproton_1_1scalar.html">scalar</a>& x) { <span class="keywordflow">return</span> internal::coerce<T>(x); }</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> } <span class="comment">// proton</span></div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#endif // PROTON_SCALAR_HPP</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="aclassproton_1_1scalar_html"><div class="ttname"><a href="classproton_1_1scalar.html">proton::scalar</a></div><div class="ttdoc">A holder for an instance of any scalar AMQP type.</div><div class="ttdef"><b>Definition:</b> scalar.hpp:37</div></div> |
| <div class="ttc" id="aclassproton_1_1scalar__base_html"><div class="ttname"><a href="classproton_1_1scalar__base.html">proton::scalar_base</a></div><div class="ttdoc">The base class for scalar types.</div><div class="ttdef"><b>Definition:</b> scalar_base.hpp:60</div></div> |
| <div class="ttc" id="anull_8hpp_html"><div class="ttname"><a href="null_8hpp.html">null.hpp</a></div><div class="ttdoc">The type of the AMQP null value.</div></div> |
| <div class="ttc" id="aclassproton_1_1scalar_html_ac8bb3912a3ce86b15842e79d0b421204"><div class="ttname"><a href="classproton_1_1scalar.html#ac8bb3912a3ce86b15842e79d0b421204">proton::scalar::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clear the scalar, making it empty().</div><div class="ttdef"><b>Definition:</b> scalar.hpp:49</div></div> |
| <div class="ttc" id="aclassproton_1_1scalar_html_a247e504774a50ea9baeb9330d459a486"><div class="ttname"><a href="classproton_1_1scalar.html#a247e504774a50ea9baeb9330d459a486">proton::scalar::scalar</a></div><div class="ttdeci">scalar(const T &x)</div><div class="ttdoc">Construct from any scalar type.</div><div class="ttdef"><b>Definition:</b> scalar.hpp:43</div></div> |
| <div class="ttc" id="aclassproton_1_1scalar_html_a7166ca618a14fe7e669059cb2ebbdb8f"><div class="ttname"><a href="classproton_1_1scalar.html#a7166ca618a14fe7e669059cb2ebbdb8f">proton::scalar::operator=</a></div><div class="ttdeci">scalar & operator=(const T &x)</div><div class="ttdoc">Assign from any scalar type.</div><div class="ttdef"><b>Definition:</b> scalar.hpp:46</div></div> |
| <div class="ttc" id="ascalar__base_8hpp_html"><div class="ttname"><a href="scalar__base_8hpp.html">scalar_base.hpp</a></div><div class="ttdoc">The base class for scalar types.</div></div> |
| <div class="ttc" id="anamespaceproton_html_ab73c44b530463fda5e11bc403ca9edd3"><div class="ttname"><a href="namespaceproton.html#ab73c44b530463fda5e11bc403ca9edd3">proton::coerce</a></div><div class="ttdeci">T coerce(const annotation_key &x)</div><div class="ttdoc">Get the binary value or throw conversion_error.</div><div class="ttdef"><b>Definition:</b> annotation_key.hpp:83</div></div> |
| <div class="ttc" id="anamespaceproton_html_a61968283b9e1fc067dcad67e9fe58f6a"><div class="ttname"><a href="namespaceproton.html#a61968283b9e1fc067dcad67e9fe58f6a">proton::get</a></div><div class="ttdeci">T get(const scalar &s)</div><div class="ttdoc">Get a contained value of type T.</div><div class="ttdef"><b>Definition:</b> scalar.hpp:60</div></div> |
| <div class="ttc" id="aclassproton_1_1scalar_html_a79453d11d5d0a0ab021762a68a73d97e"><div class="ttname"><a href="classproton_1_1scalar.html#a79453d11d5d0a0ab021762a68a73d97e">proton::scalar::scalar</a></div><div class="ttdeci">scalar()</div><div class="ttdoc">Create an empty scalar.</div><div class="ttdef"><b>Definition:</b> scalar.hpp:40</div></div> |
| <div class="ttc" id="anamespaceproton_html"><div class="ttname"><a href="namespaceproton.html">proton</a></div><div class="ttdoc">The main Proton namespace.</div><div class="ttdef"><b>Definition:</b> annotation_key.hpp:33</div></div> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="scalar_8hpp.html">scalar.hpp</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> |
