Files
pip/doc/html/class_p_i_string_list.html

252 lines
18 KiB
HTML

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PIP: PIStringList 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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</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">PIP
&#160;<span id="projectnumber">1.4.0</span>
</div>
<div id="projectbrief">Platform-Independent Primitives</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></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('class_p_i_string_list.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="class_p_i_string_list-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PIStringList Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Strings array class.
<a href="class_p_i_string_list.html#details">More...</a></p>
<p>Inherits PIDeque&lt; T &gt;.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2e303b0d998cc4a3d1801a4ae58a095d"><td class="memItemLeft" align="right" valign="top"><a id="a2e303b0d998cc4a3d1801a4ae58a095d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#a2e303b0d998cc4a3d1801a4ae58a095d">PIStringList</a> ()</td></tr>
<tr class="memdesc:a2e303b0d998cc4a3d1801a4ae58a095d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contructs empty strings list. <br /></td></tr>
<tr class="separator:a2e303b0d998cc4a3d1801a4ae58a095d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a637847edb01e44dbd98fd636e870d8da"><td class="memItemLeft" align="right" valign="top"><a id="a637847edb01e44dbd98fd636e870d8da"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#a637847edb01e44dbd98fd636e870d8da">PIStringList</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;str)</td></tr>
<tr class="memdesc:a637847edb01e44dbd98fd636e870d8da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contructs strings list with one string "str". <br /></td></tr>
<tr class="separator:a637847edb01e44dbd98fd636e870d8da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a619a3fadd772a3ceb4f7433aaaa707d5"><td class="memItemLeft" align="right" valign="top"><a id="a619a3fadd772a3ceb4f7433aaaa707d5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#a619a3fadd772a3ceb4f7433aaaa707d5">PIStringList</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;s0, const <a class="el" href="class_p_i_string.html">PIString</a> &amp;s1)</td></tr>
<tr class="memdesc:a619a3fadd772a3ceb4f7433aaaa707d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contructs empty strings list with strings "s0" and "s1". <br /></td></tr>
<tr class="separator:a619a3fadd772a3ceb4f7433aaaa707d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a204dafd0021fb841cdb52cf2a01a0ef5"><td class="memItemLeft" align="right" valign="top"><a id="a204dafd0021fb841cdb52cf2a01a0ef5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#a204dafd0021fb841cdb52cf2a01a0ef5">PIStringList</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;s0, const <a class="el" href="class_p_i_string.html">PIString</a> &amp;s1, const <a class="el" href="class_p_i_string.html">PIString</a> &amp;s2)</td></tr>
<tr class="memdesc:a204dafd0021fb841cdb52cf2a01a0ef5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contructs empty strings list with strings "s0", "s1" and "s2". <br /></td></tr>
<tr class="separator:a204dafd0021fb841cdb52cf2a01a0ef5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79c640961baae9bbf10935245eaf3339"><td class="memItemLeft" align="right" valign="top"><a id="a79c640961baae9bbf10935245eaf3339"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#a79c640961baae9bbf10935245eaf3339">PIStringList</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;s0, const <a class="el" href="class_p_i_string.html">PIString</a> &amp;s1, const <a class="el" href="class_p_i_string.html">PIString</a> &amp;s2, const <a class="el" href="class_p_i_string.html">PIString</a> &amp;s3)</td></tr>
<tr class="memdesc:a79c640961baae9bbf10935245eaf3339"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contructs empty strings list with strings "s0", "s1", "s2" and "s3". <br /></td></tr>
<tr class="separator:a79c640961baae9bbf10935245eaf3339"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28df26131bc2dc63125058bc8c6a5669"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_p_i_string.html">PIString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#a28df26131bc2dc63125058bc8c6a5669">join</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;delim) const</td></tr>
<tr class="memdesc:a28df26131bc2dc63125058bc8c6a5669"><td class="mdescLeft">&#160;</td><td class="mdescRight">Join all strings in one with delimiter "delim" and return it. <a href="#a28df26131bc2dc63125058bc8c6a5669">More...</a><br /></td></tr>
<tr class="separator:a28df26131bc2dc63125058bc8c6a5669"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b3c809c1c93ddab639d2163da783043"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_p_i_string_list.html">PIStringList</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#a7b3c809c1c93ddab639d2163da783043">removeStrings</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;value)</td></tr>
<tr class="memdesc:a7b3c809c1c93ddab639d2163da783043"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove all strings equal "value" and return this. <a href="#a7b3c809c1c93ddab639d2163da783043">More...</a><br /></td></tr>
<tr class="separator:a7b3c809c1c93ddab639d2163da783043"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7e798057ddb99a7cca519ccf3aaba8d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_p_i_string_list.html">PIStringList</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#af7e798057ddb99a7cca519ccf3aaba8d">removeDuplicates</a> ()</td></tr>
<tr class="memdesc:af7e798057ddb99a7cca519ccf3aaba8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove duplicated strings and return this. <a href="#af7e798057ddb99a7cca519ccf3aaba8d">More...</a><br /></td></tr>
<tr class="separator:af7e798057ddb99a7cca519ccf3aaba8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebcbef8d88b0081f7081a23331f66364"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_p_i_string_list.html">PIStringList</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#aebcbef8d88b0081f7081a23331f66364">trim</a> ()</td></tr>
<tr class="memdesc:aebcbef8d88b0081f7081a23331f66364"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trim all strings. <a href="#aebcbef8d88b0081f7081a23331f66364">More...</a><br /></td></tr>
<tr class="separator:aebcbef8d88b0081f7081a23331f66364"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1d6f27922acdb2de9e8b37cd20ccd50"><td class="memItemLeft" align="right" valign="top"><a id="ab1d6f27922acdb2de9e8b37cd20ccd50"></a>
uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#ab1d6f27922acdb2de9e8b37cd20ccd50">contentSize</a> ()</td></tr>
<tr class="memdesc:ab1d6f27922acdb2de9e8b37cd20ccd50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return sum of lengths of all strings. <br /></td></tr>
<tr class="separator:ab1d6f27922acdb2de9e8b37cd20ccd50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6b3fcb577618b00d14cc041c9185ae6"><td class="memItemLeft" align="right" valign="top"><a id="af6b3fcb577618b00d14cc041c9185ae6"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#af6b3fcb577618b00d14cc041c9185ae6">operator==</a> (const <a class="el" href="class_p_i_string_list.html">PIStringList</a> &amp;o) const</td></tr>
<tr class="memdesc:af6b3fcb577618b00d14cc041c9185ae6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare operator. <br /></td></tr>
<tr class="separator:af6b3fcb577618b00d14cc041c9185ae6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d3c47f2df26e7ac4747c53de26dd97a"><td class="memItemLeft" align="right" valign="top"><a id="a3d3c47f2df26e7ac4747c53de26dd97a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#a3d3c47f2df26e7ac4747c53de26dd97a">operator!=</a> (const <a class="el" href="class_p_i_string_list.html">PIStringList</a> &amp;o) const</td></tr>
<tr class="memdesc:a3d3c47f2df26e7ac4747c53de26dd97a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare operator. <br /></td></tr>
<tr class="separator:a3d3c47f2df26e7ac4747c53de26dd97a"><td class="memSeparator" colspan="2">&#160;</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:ab2ace08e93a4de6b184b29bf3d690467"><td class="memItemLeft" align="right" valign="top"><a id="ab2ace08e93a4de6b184b29bf3d690467"></a>
std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_string_list.html#ab2ace08e93a4de6b184b29bf3d690467">operator&lt;&lt;</a> (std::ostream &amp;s, const <a class="el" href="class_p_i_string_list.html">PIStringList</a> &amp;v)</td></tr>
<tr class="memdesc:ab2ace08e93a4de6b184b29bf3d690467"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output operator to std::ostream (cout) <br /></td></tr>
<tr class="separator:ab2ace08e93a4de6b184b29bf3d690467"><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>Strings array class. </p>
<p>This class is based on <em>PIDeque&lt;PIString&gt;</em> and expand it functionality. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a28df26131bc2dc63125058bc8c6a5669"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28df26131bc2dc63125058bc8c6a5669">&#9670;&nbsp;</a></span>join()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_p_i_string.html">PIString</a> PIStringList::join </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_p_i_string.html">PIString</a> &amp;&#160;</td>
<td class="paramname"><em>delim</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>Join all strings in one with delimiter "delim" and return it. </p>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="class_p_i_string_list.html">PIStringList</a> sl(<span class="stringliteral">&quot;1&quot;</span>, <span class="stringliteral">&quot;2&quot;</span>);</div><div class="line">sl &lt;&lt; <span class="stringliteral">&quot;3&quot;</span>;</div><div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> &lt;&lt; sl.join(<span class="stringliteral">&quot; &lt; &quot;</span>); <span class="comment">// 1 &lt; 2 &lt; 3</span></div></div><!-- fragment -->
</div>
</div>
<a id="a7b3c809c1c93ddab639d2163da783043"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b3c809c1c93ddab639d2163da783043">&#9670;&nbsp;</a></span>removeStrings()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_p_i_string_list.html">PIStringList</a>&amp; PIStringList::removeStrings </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_p_i_string.html">PIString</a> &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove all strings equal "value" and return this. </p>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="class_p_i_string_list.html">PIStringList</a> sl(<span class="stringliteral">&quot;1&quot;</span>, <span class="stringliteral">&quot;2&quot;</span>);</div><div class="line">sl &lt;&lt; <span class="stringliteral">&quot;1&quot;</span> &lt;&lt; <span class="stringliteral">&quot;2&quot;</span> &lt;&lt; <span class="stringliteral">&quot;3&quot;</span>;</div><div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> &lt;&lt; sl; <span class="comment">// {&quot;1&quot;, &quot;2&quot;, &quot;1&quot;, &quot;2&quot;, &quot;3&quot;}</span></div><div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> &lt;&lt; sl.removeStrings(<span class="stringliteral">&quot;1&quot;</span>); <span class="comment">// {&quot;2&quot;, &quot;2&quot;, &quot;3&quot;}</span></div></div><!-- fragment -->
</div>
</div>
<a id="af7e798057ddb99a7cca519ccf3aaba8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7e798057ddb99a7cca519ccf3aaba8d">&#9670;&nbsp;</a></span>removeDuplicates()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_p_i_string_list.html">PIStringList</a> &amp; PIStringList::removeDuplicates </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove duplicated strings and return this. </p>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="class_p_i_string_list.html">PIStringList</a> sl(<span class="stringliteral">&quot;1&quot;</span>, <span class="stringliteral">&quot;2&quot;</span>);</div><div class="line">sl &lt;&lt; <span class="stringliteral">&quot;1&quot;</span> &lt;&lt; <span class="stringliteral">&quot;2&quot;</span> &lt;&lt; <span class="stringliteral">&quot;3&quot;</span>;</div><div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> &lt;&lt; sl; <span class="comment">// {&quot;1&quot;, &quot;2&quot;, &quot;1&quot;, &quot;2&quot;, &quot;3&quot;}</span></div><div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> &lt;&lt; sl.removeDuplicates(); <span class="comment">// {&quot;1&quot;, &quot;2&quot;, &quot;3&quot;}</span></div></div><!-- fragment -->
</div>
</div>
<a id="aebcbef8d88b0081f7081a23331f66364"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebcbef8d88b0081f7081a23331f66364">&#9670;&nbsp;</a></span>trim()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_p_i_string_list.html">PIStringList</a>&amp; PIStringList::trim </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Trim all strings. </p>
<p>Example: </p><div class="fragment"></div><!-- fragment -->
</div>
</div>
</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="class_p_i_string_list.html">PIStringList</a></li>
<li class="footer">Generated on Fri Dec 8 2017 16:36:05 for PIP by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>