api/classiceberg_1_1Command.html - iceberg-cpp - Git at Google

 <!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" lang="en-US">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.9.8"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>iceberg-cpp: iceberg::Command 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="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>
 <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 id="projectrow">
   <td id="projectalign">
    <div id="projectname">iceberg-cpp
    </div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.9.8 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
 /* @license-end */
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 $(function() {
   initMenu('',true,false,'search.php','Search');
   $(document).ready(function() { init_search(); });
 });
 /* @license-end */
 </script>
 <div id="main-nav"></div>
 <!-- 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">
 <div id="MSearchResults">
 <div class="SRPage">
 <div id="SRIndex">
 <div id="SRResults"></div>
 <div class="SRStatus" id="Loading">Loading...</div>
 <div class="SRStatus" id="Searching">Searching...</div>
 <div class="SRStatus" id="NoMatches">No Matches</div>
 </div>
 </div>
 </div>
 </div>

 <div id="nav-path" class="navpath">
   <ul>
 <li class="navelem"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1Command.html">Command</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="classiceberg_1_1Command-members.html">List of all members</a>  </div>
   <div class="headertitle"><div class="title">iceberg::Command Class Reference</div></div>
 </div><!--header-->
 <div class="contents">

 <p>A shell command builder and executor for tests.
  <a href="classiceberg_1_1Command.html#details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="cmd__util_8h_source.html">cmd_util.h</a>&gt;</code></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
 <tr class="memitem:a0ee372e7fa720220e45862656fbe3a4d" id="r_a0ee372e7fa720220e45862656fbe3a4d"><td class="memItemLeft" align="right" valign="top"><a id="a0ee372e7fa720220e45862656fbe3a4d" name="a0ee372e7fa720220e45862656fbe3a4d"></a>
 &#160;</td><td class="memItemRight" valign="bottom"><b>Command</b> (std::string program)</td></tr>
 <tr class="separator:a0ee372e7fa720220e45862656fbe3a4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a3cf5de84ee7f3247db5401cf9f3040de" id="r_a3cf5de84ee7f3247db5401cf9f3040de"><td class="memItemLeft" align="right" valign="top"><a id="a3cf5de84ee7f3247db5401cf9f3040de" name="a3cf5de84ee7f3247db5401cf9f3040de"></a>
 <a class="el" href="classiceberg_1_1Command.html">Command</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Arg</b> (std::string arg)</td></tr>
 <tr class="memdesc:a3cf5de84ee7f3247db5401cf9f3040de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a single argument. <br /></td></tr>
 <tr class="separator:a3cf5de84ee7f3247db5401cf9f3040de"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a3ce3c9edf5ef6f03acfe4920c4895aab" id="r_a3ce3c9edf5ef6f03acfe4920c4895aab"><td class="memItemLeft" align="right" valign="top"><a id="a3ce3c9edf5ef6f03acfe4920c4895aab" name="a3ce3c9edf5ef6f03acfe4920c4895aab"></a>
 <a class="el" href="classiceberg_1_1Command.html">Command</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Args</b> (const std::vector&lt; std::string &gt; &amp;args)</td></tr>
 <tr class="memdesc:a3ce3c9edf5ef6f03acfe4920c4895aab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add multiple arguments at once. <br /></td></tr>
 <tr class="separator:a3ce3c9edf5ef6f03acfe4920c4895aab"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ae3e1ec5384671a0bcfb0cf2cb3596056" id="r_ae3e1ec5384671a0bcfb0cf2cb3596056"><td class="memItemLeft" align="right" valign="top"><a id="ae3e1ec5384671a0bcfb0cf2cb3596056" name="ae3e1ec5384671a0bcfb0cf2cb3596056"></a>
 <a class="el" href="classiceberg_1_1Command.html">Command</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>CurrentDir</b> (const std::filesystem::path &amp;path)</td></tr>
 <tr class="memdesc:ae3e1ec5384671a0bcfb0cf2cb3596056"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current working directory for the command. <br /></td></tr>
 <tr class="separator:ae3e1ec5384671a0bcfb0cf2cb3596056"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4f7da9f4b7a0a2d7c4e30b0fcc0510fc" id="r_a4f7da9f4b7a0a2d7c4e30b0fcc0510fc"><td class="memItemLeft" align="right" valign="top"><a id="a4f7da9f4b7a0a2d7c4e30b0fcc0510fc" name="a4f7da9f4b7a0a2d7c4e30b0fcc0510fc"></a>
 <a class="el" href="classiceberg_1_1Command.html">Command</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Env</b> (const std::string &amp;key, const std::string &amp;val)</td></tr>
 <tr class="memdesc:a4f7da9f4b7a0a2d7c4e30b0fcc0510fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set an environment variable for the command. <br /></td></tr>
 <tr class="separator:a4f7da9f4b7a0a2d7c4e30b0fcc0510fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a852fb0a2dc8e3b040d2edd5490cbf5f6" id="r_a852fb0a2dc8e3b040d2edd5490cbf5f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Command.html#a852fb0a2dc8e3b040d2edd5490cbf5f6">RunCommand</a> (const std::string &amp;desc) const</td></tr>
 <tr class="memdesc:a852fb0a2dc8e3b040d2edd5490cbf5f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the command and print logs.  <br /></td></tr>
 <tr class="separator:a852fb0a2dc8e3b040d2edd5490cbf5f6"><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>A shell command builder and executor for tests. </p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
 <a id="a852fb0a2dc8e3b040d2edd5490cbf5f6" name="a852fb0a2dc8e3b040d2edd5490cbf5f6"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a852fb0a2dc8e3b040d2edd5490cbf5f6">&#9670;&#160;</a></span>RunCommand()</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void iceberg::Command::RunCommand </td>
           <td>(</td>
           <td class="paramtype">const std::string &amp;&#160;</td>
           <td class="paramname"><em>desc</em></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Execute the command and print logs. </p>
 <dl class="section return"><dt>Returns</dt><dd>A Status indicating success or failure </dd></dl>

 </div>
 </div>
 <hr/>The documentation for this class was generated from the following files:<ul>
 <li>iceberg/test/util/<a class="el" href="cmd__util_8h_source.html">cmd_util.h</a></li>
 <li>iceberg/test/util/<b>cmd_util.cc</b></li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
 </small></address>
 </body>
 </html>
	<!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" lang="en-US">
	<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=11"/>
	<meta name="generator" content="Doxygen 1.9.8"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>iceberg-cpp: iceberg::Command 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="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>
	<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 id="projectrow">
	<td id="projectalign">
	<div id="projectname">iceberg-cpp
	</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.9.8 -->
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	var searchBox = new SearchBox("searchBox", "search/",'.html');
	/* @license-end */
	</script>
	<script type="text/javascript" src="menudata.js"></script>
	<script type="text/javascript" src="menu.js"></script>
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	$(function() {
	initMenu('',true,false,'search.php','Search');
	$(document).ready(function() { init_search(); });
	});
	/* @license-end */
	</script>
	<div id="main-nav"></div>
	<!-- 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">
	<div id="MSearchResults">
	<div class="SRPage">
	<div id="SRIndex">
	<div id="SRResults"></div>
	<div class="SRStatus" id="Loading">Loading...</div>
	<div class="SRStatus" id="Searching">Searching...</div>
	<div class="SRStatus" id="NoMatches">No Matches</div>
	</div>
	</div>
	</div>
	</div>

	<div id="nav-path" class="navpath">
	<ul>
	<li class="navelem"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1Command.html">Command</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#pub-methods">Public Member Functions</a> \|
	<a href="classiceberg_1_1Command-members.html">List of all members</a> </div>
	<div class="headertitle"><div class="title">iceberg::Command Class Reference</div></div>
	</div><!--header-->
	<div class="contents">

	<p>A shell command builder and executor for tests.
	<a href="classiceberg_1_1Command.html#details">More...</a></p>

	<p><code>#include <<a class="el" href="cmd__util_8h_source.html">cmd_util.h</a>></code></p>
	<table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
	Public Member Functions</h2></td></tr>
	<tr class="memitem:a0ee372e7fa720220e45862656fbe3a4d" id="r_a0ee372e7fa720220e45862656fbe3a4d"><td class="memItemLeft" align="right" valign="top"><a id="a0ee372e7fa720220e45862656fbe3a4d" name="a0ee372e7fa720220e45862656fbe3a4d"></a>
	</td><td class="memItemRight" valign="bottom"><b>Command</b> (std::string program)</td></tr>
	<tr class="separator:a0ee372e7fa720220e45862656fbe3a4d"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a3cf5de84ee7f3247db5401cf9f3040de" id="r_a3cf5de84ee7f3247db5401cf9f3040de"><td class="memItemLeft" align="right" valign="top"><a id="a3cf5de84ee7f3247db5401cf9f3040de" name="a3cf5de84ee7f3247db5401cf9f3040de"></a>
	<a class="el" href="classiceberg_1_1Command.html">Command</a> & </td><td class="memItemRight" valign="bottom"><b>Arg</b> (std::string arg)</td></tr>
	<tr class="memdesc:a3cf5de84ee7f3247db5401cf9f3040de"><td class="mdescLeft"> </td><td class="mdescRight">Add a single argument. <br /></td></tr>
	<tr class="separator:a3cf5de84ee7f3247db5401cf9f3040de"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a3ce3c9edf5ef6f03acfe4920c4895aab" id="r_a3ce3c9edf5ef6f03acfe4920c4895aab"><td class="memItemLeft" align="right" valign="top"><a id="a3ce3c9edf5ef6f03acfe4920c4895aab" name="a3ce3c9edf5ef6f03acfe4920c4895aab"></a>
	<a class="el" href="classiceberg_1_1Command.html">Command</a> & </td><td class="memItemRight" valign="bottom"><b>Args</b> (const std::vector< std::string > &args)</td></tr>
	<tr class="memdesc:a3ce3c9edf5ef6f03acfe4920c4895aab"><td class="mdescLeft"> </td><td class="mdescRight">Add multiple arguments at once. <br /></td></tr>
	<tr class="separator:a3ce3c9edf5ef6f03acfe4920c4895aab"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:ae3e1ec5384671a0bcfb0cf2cb3596056" id="r_ae3e1ec5384671a0bcfb0cf2cb3596056"><td class="memItemLeft" align="right" valign="top"><a id="ae3e1ec5384671a0bcfb0cf2cb3596056" name="ae3e1ec5384671a0bcfb0cf2cb3596056"></a>
	<a class="el" href="classiceberg_1_1Command.html">Command</a> & </td><td class="memItemRight" valign="bottom"><b>CurrentDir</b> (const std::filesystem::path &path)</td></tr>
	<tr class="memdesc:ae3e1ec5384671a0bcfb0cf2cb3596056"><td class="mdescLeft"> </td><td class="mdescRight">Set the current working directory for the command. <br /></td></tr>
	<tr class="separator:ae3e1ec5384671a0bcfb0cf2cb3596056"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a4f7da9f4b7a0a2d7c4e30b0fcc0510fc" id="r_a4f7da9f4b7a0a2d7c4e30b0fcc0510fc"><td class="memItemLeft" align="right" valign="top"><a id="a4f7da9f4b7a0a2d7c4e30b0fcc0510fc" name="a4f7da9f4b7a0a2d7c4e30b0fcc0510fc"></a>
	<a class="el" href="classiceberg_1_1Command.html">Command</a> & </td><td class="memItemRight" valign="bottom"><b>Env</b> (const std::string &key, const std::string &val)</td></tr>
	<tr class="memdesc:a4f7da9f4b7a0a2d7c4e30b0fcc0510fc"><td class="mdescLeft"> </td><td class="mdescRight">Set an environment variable for the command. <br /></td></tr>
	<tr class="separator:a4f7da9f4b7a0a2d7c4e30b0fcc0510fc"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a852fb0a2dc8e3b040d2edd5490cbf5f6" id="r_a852fb0a2dc8e3b040d2edd5490cbf5f6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Command.html#a852fb0a2dc8e3b040d2edd5490cbf5f6">RunCommand</a> (const std::string &desc) const</td></tr>
	<tr class="memdesc:a852fb0a2dc8e3b040d2edd5490cbf5f6"><td class="mdescLeft"> </td><td class="mdescRight">Execute the command and print logs. <br /></td></tr>
	<tr class="separator:a852fb0a2dc8e3b040d2edd5490cbf5f6"><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 shell command builder and executor for tests. </p>
	</div><h2 class="groupheader">Member Function Documentation</h2>
	<a id="a852fb0a2dc8e3b040d2edd5490cbf5f6" name="a852fb0a2dc8e3b040d2edd5490cbf5f6"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a852fb0a2dc8e3b040d2edd5490cbf5f6">◆ </a></span>RunCommand()</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">void iceberg::Command::RunCommand </td>
	<td>(</td>
	<td class="paramtype">const std::string & </td>
	<td class="paramname"><em>desc</em></td><td>)</td>
	<td> const</td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Execute the command and print logs. </p>
	<dl class="section return"><dt>Returns</dt><dd>A Status indicating success or failure </dd></dl>

	</div>
	</div>
	<hr/>The documentation for this class was generated from the following files:<ul>
	<li>iceberg/test/util/<a class="el" href="cmd__util_8h_source.html">cmd_util.h</a></li>
	<li>iceberg/test/util/<b>cmd_util.cc</b></li>
	</ul>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
	</small></address>
	</body>
	</html>