blob: 567c06e126b1e6cea3240ae28d061e73fd99e8e0 [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>
<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.6"/>
<title>Paho C++: mqtt::string_collection 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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="pahologo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Paho C++
&#160;<span id="projectnumber">1.0</span>
</div>
<div id="projectbrief">The Paho MQTT C++ Client Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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 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>
</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">
$(document).ready(function(){initNavTree('classmqtt_1_1string__collection.html','');});
</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Friends</a></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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classmqtt_1_1string__collection-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mqtt::string_collection Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Type for a collection of topics.
<a href="classmqtt_1_1string__collection.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="string__collection_8h_source.html">string_collection.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a4f73d60180e32e7f067626b57878bf67"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f73d60180e32e7f067626b57878bf67"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a> = std::shared_ptr&lt; <a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &gt;</td></tr>
<tr class="memdesc:a4f73d60180e32e7f067626b57878bf67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Smart/shared pointer to an object of this type. <br/></td></tr>
<tr class="separator:a4f73d60180e32e7f067626b57878bf67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a490f1ac1b411a84ad54f9b2337992c36"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a490f1ac1b411a84ad54f9b2337992c36"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a490f1ac1b411a84ad54f9b2337992c36">const_ptr_t</a> = std::shared_ptr&lt; const <a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &gt;</td></tr>
<tr class="memdesc:a490f1ac1b411a84ad54f9b2337992c36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Smart/shared pointer to a const object of this type. <br/></td></tr>
<tr class="separator:a490f1ac1b411a84ad54f9b2337992c36"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a74a9a5e1fe2f00b3fffe65172e2b4dec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74a9a5e1fe2f00b3fffe65172e2b4dec"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a74a9a5e1fe2f00b3fffe65172e2b4dec">string_collection</a> ()=default</td></tr>
<tr class="memdesc:a74a9a5e1fe2f00b3fffe65172e2b4dec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an empty string collection. <br/></td></tr>
<tr class="separator:a74a9a5e1fe2f00b3fffe65172e2b4dec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66b1550576f33eff14ab1b22b2c5cb87"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a66b1550576f33eff14ab1b22b2c5cb87">string_collection</a> (const string &amp;str)</td></tr>
<tr class="memdesc:a66b1550576f33eff14ab1b22b2c5cb87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a collection initially containing a single string. <a href="#a66b1550576f33eff14ab1b22b2c5cb87">More...</a><br/></td></tr>
<tr class="separator:a66b1550576f33eff14ab1b22b2c5cb87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98abbaf87b964690ba032725ac6c7502"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a98abbaf87b964690ba032725ac6c7502">string_collection</a> (string &amp;&amp;str)</td></tr>
<tr class="memdesc:a98abbaf87b964690ba032725ac6c7502"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a collection initially containing a single string. <a href="#a98abbaf87b964690ba032725ac6c7502">More...</a><br/></td></tr>
<tr class="separator:a98abbaf87b964690ba032725ac6c7502"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f07bc279fe80beb50f6f379ce945e3d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a4f07bc279fe80beb50f6f379ce945e3d">string_collection</a> (const collection_type &amp;vec)</td></tr>
<tr class="memdesc:a4f07bc279fe80beb50f6f379ce945e3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a string collection by copying a vector of strings. <a href="#a4f07bc279fe80beb50f6f379ce945e3d">More...</a><br/></td></tr>
<tr class="separator:a4f07bc279fe80beb50f6f379ce945e3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fc14ddbc45bd85c22ec03dd88efb2dc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a9fc14ddbc45bd85c22ec03dd88efb2dc">string_collection</a> (collection_type &amp;&amp;vec)</td></tr>
<tr class="memdesc:a9fc14ddbc45bd85c22ec03dd88efb2dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a string collection by moving a vector of strings. <a href="#a9fc14ddbc45bd85c22ec03dd88efb2dc">More...</a><br/></td></tr>
<tr class="separator:a9fc14ddbc45bd85c22ec03dd88efb2dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39cb2c38a7ca6adb3df27bd1f01443dd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a39cb2c38a7ca6adb3df27bd1f01443dd">string_collection</a> (const <a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &amp;coll)</td></tr>
<tr class="memdesc:a39cb2c38a7ca6adb3df27bd1f01443dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="#a39cb2c38a7ca6adb3df27bd1f01443dd">More...</a><br/></td></tr>
<tr class="separator:a39cb2c38a7ca6adb3df27bd1f01443dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bd7945fc3d01fe3d3dde7ae9c6e4e9d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a4bd7945fc3d01fe3d3dde7ae9c6e4e9d">string_collection</a> (<a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &amp;&amp;coll)=default</td></tr>
<tr class="memdesc:a4bd7945fc3d01fe3d3dde7ae9c6e4e9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <a href="#a4bd7945fc3d01fe3d3dde7ae9c6e4e9d">More...</a><br/></td></tr>
<tr class="separator:a4bd7945fc3d01fe3d3dde7ae9c6e4e9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f813bf66ae466e72cfd5df3eb7e784f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a3f813bf66ae466e72cfd5df3eb7e784f">string_collection</a> (std::initializer_list&lt; string &gt; sl)</td></tr>
<tr class="memdesc:a3f813bf66ae466e72cfd5df3eb7e784f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a string collection from an initialization list of strings. <a href="#a3f813bf66ae466e72cfd5df3eb7e784f">More...</a><br/></td></tr>
<tr class="separator:a3f813bf66ae466e72cfd5df3eb7e784f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e8e7f011334dbbc20c15900c9fc833f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a1e8e7f011334dbbc20c15900c9fc833f">string_collection</a> (std::initializer_list&lt; const char * &gt; sl)</td></tr>
<tr class="memdesc:a1e8e7f011334dbbc20c15900c9fc833f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a string collection from an initialization list of C string pointers. <a href="#a1e8e7f011334dbbc20c15900c9fc833f">More...</a><br/></td></tr>
<tr class="separator:a1e8e7f011334dbbc20c15900c9fc833f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92a297a4bfdc1f801c4d1fbc2c5a425f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a92a297a4bfdc1f801c4d1fbc2c5a425f">operator=</a> (const <a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &amp;coll)</td></tr>
<tr class="memdesc:a92a297a4bfdc1f801c4d1fbc2c5a425f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy assignment. <a href="#a92a297a4bfdc1f801c4d1fbc2c5a425f">More...</a><br/></td></tr>
<tr class="separator:a92a297a4bfdc1f801c4d1fbc2c5a425f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc8a7e2144d791dcc6018955903e275b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#adc8a7e2144d791dcc6018955903e275b">operator=</a> (<a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &amp;&amp;coll)=default</td></tr>
<tr class="memdesc:adc8a7e2144d791dcc6018955903e275b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment. <a href="#adc8a7e2144d791dcc6018955903e275b">More...</a><br/></td></tr>
<tr class="separator:adc8a7e2144d791dcc6018955903e275b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af55c63c092dbf2b206dd93b73316dc96"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#af55c63c092dbf2b206dd93b73316dc96">empty</a> () const </td></tr>
<tr class="memdesc:af55c63c092dbf2b206dd93b73316dc96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if the collection is empty. <a href="#af55c63c092dbf2b206dd93b73316dc96">More...</a><br/></td></tr>
<tr class="separator:af55c63c092dbf2b206dd93b73316dc96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad91c18c3dae8baccf5ebfb0d7c194e04"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#ad91c18c3dae8baccf5ebfb0d7c194e04">size</a> () const </td></tr>
<tr class="memdesc:ad91c18c3dae8baccf5ebfb0d7c194e04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number of strings in the collection. <a href="#ad91c18c3dae8baccf5ebfb0d7c194e04">More...</a><br/></td></tr>
<tr class="separator:ad91c18c3dae8baccf5ebfb0d7c194e04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56a3ded249c5c5ea81536459e274573a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a56a3ded249c5c5ea81536459e274573a">push_back</a> (const string &amp;str)</td></tr>
<tr class="memdesc:a56a3ded249c5c5ea81536459e274573a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies a string to the back of the collection. <a href="#a56a3ded249c5c5ea81536459e274573a">More...</a><br/></td></tr>
<tr class="separator:a56a3ded249c5c5ea81536459e274573a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87d730c9356ea3594f937d2705c2ae8b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a87d730c9356ea3594f937d2705c2ae8b">push_back</a> (string &amp;&amp;str)</td></tr>
<tr class="memdesc:a87d730c9356ea3594f937d2705c2ae8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves a string to the back of the collection. <a href="#a87d730c9356ea3594f937d2705c2ae8b">More...</a><br/></td></tr>
<tr class="separator:a87d730c9356ea3594f937d2705c2ae8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e4a123e5598300485b90458bfd07c3b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e4a123e5598300485b90458bfd07c3b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a6e4a123e5598300485b90458bfd07c3b">clear</a> ()</td></tr>
<tr class="memdesc:a6e4a123e5598300485b90458bfd07c3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes all the strings from the collection. <br/></td></tr>
<tr class="separator:a6e4a123e5598300485b90458bfd07c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7343668e51aa23d7949a78d55e03e09"><td class="memItemLeft" align="right" valign="top">const string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#ac7343668e51aa23d7949a78d55e03e09">operator[]</a> (size_t i) const </td></tr>
<tr class="memdesc:ac7343668e51aa23d7949a78d55e03e09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the n'th string in the collection. <a href="#ac7343668e51aa23d7949a78d55e03e09">More...</a><br/></td></tr>
<tr class="separator:ac7343668e51aa23d7949a78d55e03e09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8487ddeeb7b7893cd5ceabc0a957c33"><td class="memItemLeft" align="right" valign="top">char *const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#aa8487ddeeb7b7893cd5ceabc0a957c33">c_arr</a> () const </td></tr>
<tr class="memdesc:aa8487ddeeb7b7893cd5ceabc0a957c33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a pointer to an array of NUL-terminated C string pointers. <a href="#aa8487ddeeb7b7893cd5ceabc0a957c33">More...</a><br/></td></tr>
<tr class="separator:aa8487ddeeb7b7893cd5ceabc0a957c33"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a90037647a89f2fa09463ebc45707c5d2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a90037647a89f2fa09463ebc45707c5d2">create</a> (const string &amp;str)</td></tr>
<tr class="memdesc:a90037647a89f2fa09463ebc45707c5d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty string collection on the heap. <a href="#a90037647a89f2fa09463ebc45707c5d2">More...</a><br/></td></tr>
<tr class="separator:a90037647a89f2fa09463ebc45707c5d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add8e5b64132be97f4f117342dd0aae67"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#add8e5b64132be97f4f117342dd0aae67">create</a> (string &amp;&amp;str)</td></tr>
<tr class="memdesc:add8e5b64132be97f4f117342dd0aae67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a string collection on the heap, initially containing a single string. <a href="#add8e5b64132be97f4f117342dd0aae67">More...</a><br/></td></tr>
<tr class="separator:add8e5b64132be97f4f117342dd0aae67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a690f2d229a2852a50daeb08d22d54238"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a690f2d229a2852a50daeb08d22d54238">create</a> (const collection_type &amp;vec)</td></tr>
<tr class="memdesc:a690f2d229a2852a50daeb08d22d54238"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a string collection on the heap by copying a vector of strings. <a href="#a690f2d229a2852a50daeb08d22d54238">More...</a><br/></td></tr>
<tr class="separator:a690f2d229a2852a50daeb08d22d54238"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a930b0410af1e97d6ba2fe188bbdd0c42"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a930b0410af1e97d6ba2fe188bbdd0c42">create</a> (collection_type &amp;&amp;vec)</td></tr>
<tr class="memdesc:a930b0410af1e97d6ba2fe188bbdd0c42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a string collection on the heap by copying a vector of strings. <a href="#a930b0410af1e97d6ba2fe188bbdd0c42">More...</a><br/></td></tr>
<tr class="separator:a930b0410af1e97d6ba2fe188bbdd0c42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41adb5daf75eb7a351bfa93d8ebd17c4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a41adb5daf75eb7a351bfa93d8ebd17c4">create</a> (std::initializer_list&lt; string &gt; sl)</td></tr>
<tr class="memdesc:a41adb5daf75eb7a351bfa93d8ebd17c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a string collection on the heap from an initialization list of strings. <a href="#a41adb5daf75eb7a351bfa93d8ebd17c4">More...</a><br/></td></tr>
<tr class="separator:a41adb5daf75eb7a351bfa93d8ebd17c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c797fc349c47e2ac7164ec68849e7ac"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1string__collection.html#a6c797fc349c47e2ac7164ec68849e7ac">create</a> (std::initializer_list&lt; const char * &gt; sl)</td></tr>
<tr class="memdesc:a6c797fc349c47e2ac7164ec68849e7ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a string collection on the heap from an initialization list of C string pointers. <a href="#a6c797fc349c47e2ac7164ec68849e7ac">More...</a><br/></td></tr>
<tr class="separator:a6c797fc349c47e2ac7164ec68849e7ac"><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>Type for a collection of topics. </p>
<p>This acts like a collection of strings but carries an array of pointers to the C strings for easy interactions with the Paho C library. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a66b1550576f33eff14ab1b22b2c5cb87"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mqtt::string_collection::string_collection </td>
<td>(</td>
<td class="paramtype">const string &amp;&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a collection initially containing a single string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>The string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a98abbaf87b964690ba032725ac6c7502"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mqtt::string_collection::string_collection </td>
<td>(</td>
<td class="paramtype">string &amp;&amp;&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a collection initially containing a single string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>The string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4f07bc279fe80beb50f6f379ce945e3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mqtt::string_collection::string_collection </td>
<td>(</td>
<td class="paramtype">const collection_type &amp;&#160;</td>
<td class="paramname"><em>vec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a string collection by copying a vector of strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vec</td><td>A vector of strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9fc14ddbc45bd85c22ec03dd88efb2dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mqtt::string_collection::string_collection </td>
<td>(</td>
<td class="paramtype">collection_type &amp;&amp;&#160;</td>
<td class="paramname"><em>vec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a string collection by moving a vector of strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vec</td><td>A vector of strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a39cb2c38a7ca6adb3df27bd1f01443dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mqtt::string_collection::string_collection </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &amp;&#160;</td>
<td class="paramname"><em>coll</em></td><td>)</td>
<td></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">coll</td><td>An existing string collection. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4bd7945fc3d01fe3d3dde7ae9c6e4e9d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mqtt::string_collection::string_collection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>coll</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>An existing string collection. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3f813bf66ae466e72cfd5df3eb7e784f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mqtt::string_collection::string_collection </td>
<td>(</td>
<td class="paramtype">std::initializer_list&lt; string &gt;&#160;</td>
<td class="paramname"><em>sl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a string collection from an initialization list of strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sl</td><td>An initialization list of strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1e8e7f011334dbbc20c15900c9fc833f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mqtt::string_collection::string_collection </td>
<td>(</td>
<td class="paramtype">std::initializer_list&lt; const char * &gt;&#160;</td>
<td class="paramname"><em>sl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a string collection from an initialization list of C string pointers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sl</td><td>An initialization list of C character arrays. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa8487ddeeb7b7893cd5ceabc0a957c33"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">char* const* mqtt::string_collection::c_arr </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>Gets a pointer to an array of NUL-terminated C string pointers. </p>
<p>This is the collection type supported by the underlying Paho C library. The returned pointer is guaranteed valid so long as the object is not updated. The return value may change if the object is modified, so the application should not cache the return value, but rather request the value when needed. </p>
<dl class="section return"><dt>Returns</dt><dd>pointer to an array of NUL-terminated C string pointers of the topics in the object. </dd></dl>
</div>
</div>
<a class="anchor" id="a90037647a89f2fa09463ebc45707c5d2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a> mqtt::string_collection::create </td>
<td>(</td>
<td class="paramtype">const string &amp;&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an empty string collection on the heap. </p>
<dl class="section return"><dt>Returns</dt><dd>A smart/shared pointer to a string collection. </dd></dl>
</div>
</div>
<a class="anchor" id="add8e5b64132be97f4f117342dd0aae67"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a> mqtt::string_collection::create </td>
<td>(</td>
<td class="paramtype">string &amp;&amp;&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a string collection on the heap, initially containing a single string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>The string </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A smart/shared pointer to a string collection. </dd></dl>
</div>
</div>
<a class="anchor" id="a690f2d229a2852a50daeb08d22d54238"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a> mqtt::string_collection::create </td>
<td>(</td>
<td class="paramtype">const collection_type &amp;&#160;</td>
<td class="paramname"><em>vec</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a string collection on the heap by copying a vector of strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vec</td><td>A vector of strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a930b0410af1e97d6ba2fe188bbdd0c42"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a> mqtt::string_collection::create </td>
<td>(</td>
<td class="paramtype">collection_type &amp;&amp;&#160;</td>
<td class="paramname"><em>vec</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a string collection on the heap by copying a vector of strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vec</td><td>A vector of strings. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A smart/shared pointer to a string collection. </dd></dl>
</div>
</div>
<a class="anchor" id="a41adb5daf75eb7a351bfa93d8ebd17c4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a> mqtt::string_collection::create </td>
<td>(</td>
<td class="paramtype">std::initializer_list&lt; string &gt;&#160;</td>
<td class="paramname"><em>sl</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a string collection on the heap from an initialization list of strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sl</td><td>An initialization list of strings. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A smart/shared pointer to a string collection. </dd></dl>
</div>
</div>
<a class="anchor" id="a6c797fc349c47e2ac7164ec68849e7ac"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classmqtt_1_1string__collection.html#a4f73d60180e32e7f067626b57878bf67">ptr_t</a> mqtt::string_collection::create </td>
<td>(</td>
<td class="paramtype">std::initializer_list&lt; const char * &gt;&#160;</td>
<td class="paramname"><em>sl</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a string collection on the heap from an initialization list of C string pointers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sl</td><td>An initialization list of C character arrays. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A smart/shared pointer to a string collection. </dd></dl>
</div>
</div>
<a class="anchor" id="af55c63c092dbf2b206dd93b73316dc96"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mqtt::string_collection::empty </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>Determines if the collection is empty. </p>
<dl class="section return"><dt>Returns</dt><dd><em>true</em> if the collection is empty, <em>false</em> if not. </dd></dl>
</div>
</div>
<a class="anchor" id="a92a297a4bfdc1f801c4d1fbc2c5a425f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmqtt_1_1string__collection.html">string_collection</a>&amp; mqtt::string_collection::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &amp;&#160;</td>
<td class="paramname"><em>coll</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy assignment. </p>
<p>Copy another string collection to this one. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>A string collection </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to this collection. </dd></dl>
</div>
</div>
<a class="anchor" id="adc8a7e2144d791dcc6018955903e275b"></a>
<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="classmqtt_1_1string__collection.html">string_collection</a>&amp; mqtt::string_collection::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmqtt_1_1string__collection.html">string_collection</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>coll</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move assignment. </p>
<p>Move another string collection to this one. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>A string collection </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to this collection. </dd></dl>
</div>
</div>
<a class="anchor" id="ac7343668e51aa23d7949a78d55e03e09"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const string&amp; mqtt::string_collection::operator[] </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>i</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>Gets the n'th string in the collection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>Index to the desired string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A const reference to the string. </dd></dl>
</div>
</div>
<a class="anchor" id="a56a3ded249c5c5ea81536459e274573a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mqtt::string_collection::push_back </td>
<td>(</td>
<td class="paramtype">const string &amp;&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies a string to the back of the collection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>A string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a87d730c9356ea3594f937d2705c2ae8b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mqtt::string_collection::push_back </td>
<td>(</td>
<td class="paramtype">string &amp;&amp;&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves a string to the back of the collection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>A string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad91c18c3dae8baccf5ebfb0d7c194e04"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t mqtt::string_collection::size </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>Gets the number of strings in the collection. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of strings in the collection. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/mqtt/<a class="el" href="string__collection_8h_source.html">string_collection.h</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"><b>mqtt</b></li><li class="navelem"><a class="el" href="classmqtt_1_1string__collection.html">string_collection</a></li>
<li class="footer">Generated on Sun Jul 23 2017 10:24:30 for Paho C++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>