content/doxygen/html/classsinga_1_1Channel.html - singa-site - Git at Google

 <!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>Apache Singa: singa::Channel 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 style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Apache Singa
    </div>
    <div id="projectbrief">A General Distributed Deep Learning Library</div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.8.13 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
 $(function() {
   initMenu('',true,false,'search.php','Search');
   $(document).ready(function() { init_search(); });
 });
 </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">
 <iframe src="javascript:void(0)" frameborder="0"
         name="MSearchResults" id="MSearchResults">
 </iframe>
 </div>

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

 <p><a class="el" href="classsinga_1_1Channel.html" title="Channel for appending metrics or other information into files or screen. ">Channel</a> for appending metrics or other information into files or screen.
  <a href="classsinga_1_1Channel.html#details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="channel_8h_source.html">channel.h</a>&gt;</code></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:a04c3cc9b8ba8c28861d7cf13353561df"><td class="memItemLeft" align="right" valign="top"><a id="a04c3cc9b8ba8c28861d7cf13353561df"></a>
 &#160;</td><td class="memItemRight" valign="bottom"><b>Channel</b> (const std::string &amp;name)</td></tr>
 <tr class="separator:a04c3cc9b8ba8c28861d7cf13353561df"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aba152cf4c1848dacb6a50f351d8bdc99"><td class="memItemLeft" align="right" valign="top"><a id="aba152cf4c1848dacb6a50f351d8bdc99"></a>
 const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#aba152cf4c1848dacb6a50f351d8bdc99">GetName</a> ()</td></tr>
 <tr class="memdesc:aba152cf4c1848dacb6a50f351d8bdc99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the channel name, which is also used for naming the output file. <br /></td></tr>
 <tr class="separator:aba152cf4c1848dacb6a50f351d8bdc99"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ae95a868b2cbce464b2b7e065ab4dfaa7"><td class="memItemLeft" align="right" valign="top"><a id="ae95a868b2cbce464b2b7e065ab4dfaa7"></a>
 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#ae95a868b2cbce464b2b7e065ab4dfaa7">EnableDestStderr</a> (bool enable)</td></tr>
 <tr class="memdesc:ae95a868b2cbce464b2b7e065ab4dfaa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disabled by default. <br /></td></tr>
 <tr class="separator:ae95a868b2cbce464b2b7e065ab4dfaa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1b6759cf2879bc0b42dcfdbf3cfed1f0"><td class="memItemLeft" align="right" valign="top"><a id="a1b6759cf2879bc0b42dcfdbf3cfed1f0"></a>
 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#a1b6759cf2879bc0b42dcfdbf3cfed1f0">EnableDestFile</a> (bool enable)</td></tr>
 <tr class="memdesc:a1b6759cf2879bc0b42dcfdbf3cfed1f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enabled by default. <br /></td></tr>
 <tr class="separator:a1b6759cf2879bc0b42dcfdbf3cfed1f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a13af9ce49d21bf3b04c198f5580097dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#a13af9ce49d21bf3b04c198f5580097dd">SetDestFilePath</a> (const std::string &amp;file)</td></tr>
 <tr class="memdesc:a13af9ce49d21bf3b04c198f5580097dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the output file path.  <a href="#a13af9ce49d21bf3b04c198f5580097dd">More...</a><br /></td></tr>
 <tr class="separator:a13af9ce49d21bf3b04c198f5580097dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aa951f405d0cf20944afa5a73c2e166f6"><td class="memItemLeft" align="right" valign="top"><a id="aa951f405d0cf20944afa5a73c2e166f6"></a>
 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#aa951f405d0cf20944afa5a73c2e166f6">Send</a> (const std::string &amp;message)</td></tr>
 <tr class="memdesc:aa951f405d0cf20944afa5a73c2e166f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Append a string message. <br /></td></tr>
 <tr class="separator:aa951f405d0cf20944afa5a73c2e166f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a306d4777018e397a24abb29468d149d9"><td class="memItemLeft" align="right" valign="top"><a id="a306d4777018e397a24abb29468d149d9"></a>
 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#a306d4777018e397a24abb29468d149d9">Send</a> (const google::protobuf::Message &amp;message)</td></tr>
 <tr class="memdesc:a306d4777018e397a24abb29468d149d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Append a protobuf message. <br /></td></tr>
 <tr class="separator:a306d4777018e397a24abb29468d149d9"><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 class="el" href="classsinga_1_1Channel.html" title="Channel for appending metrics or other information into files or screen. ">Channel</a> for appending metrics or other information into files or screen. </p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
 <a id="a13af9ce49d21bf3b04c198f5580097dd"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a13af9ce49d21bf3b04c198f5580097dd">&#9670;&nbsp;</a></span>SetDestFilePath()</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void singa::Channel::SetDestFilePath </td>
           <td>(</td>
           <td class="paramtype">const std::string &amp;&#160;</td>
           <td class="paramname"><em>file</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Reset the output file path. </p>
 <p>The dest file is named as global dir + channel name by default. </p>

 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>
 <li>/home/moaz/incubator-singa/include/singa/utils/<a class="el" href="channel_8h_source.html">channel.h</a></li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.13
 </small></address>
 </body>
 </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>Apache Singa: singa::Channel 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 style="height: 56px;">
	<td id="projectalign" style="padding-left: 0.5em;">
	<div id="projectname">Apache Singa
	</div>
	<div id="projectbrief">A General Distributed Deep Learning Library</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.8.13 -->
	<script type="text/javascript">
	var searchBox = new SearchBox("searchBox", "search",false,'Search');
	</script>
	<script type="text/javascript" src="menudata.js"></script>
	<script type="text/javascript" src="menu.js"></script>
	<script type="text/javascript">
	$(function() {
	initMenu('',true,false,'search.php','Search');
	$(document).ready(function() { init_search(); });
	});
	</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">
	<iframe src="javascript:void(0)" frameborder="0"
	name="MSearchResults" id="MSearchResults">
	</iframe>
	</div>

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

	<p><a class="el" href="classsinga_1_1Channel.html" title="Channel for appending metrics or other information into files or screen. ">Channel</a> for appending metrics or other information into files or screen.
	<a href="classsinga_1_1Channel.html#details">More...</a></p>

	<p><code>#include <<a class="el" href="channel_8h_source.html">channel.h</a>></code></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:a04c3cc9b8ba8c28861d7cf13353561df"><td class="memItemLeft" align="right" valign="top"><a id="a04c3cc9b8ba8c28861d7cf13353561df"></a>
	</td><td class="memItemRight" valign="bottom"><b>Channel</b> (const std::string &name)</td></tr>
	<tr class="separator:a04c3cc9b8ba8c28861d7cf13353561df"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:aba152cf4c1848dacb6a50f351d8bdc99"><td class="memItemLeft" align="right" valign="top"><a id="aba152cf4c1848dacb6a50f351d8bdc99"></a>
	const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#aba152cf4c1848dacb6a50f351d8bdc99">GetName</a> ()</td></tr>
	<tr class="memdesc:aba152cf4c1848dacb6a50f351d8bdc99"><td class="mdescLeft"> </td><td class="mdescRight">Return the channel name, which is also used for naming the output file. <br /></td></tr>
	<tr class="separator:aba152cf4c1848dacb6a50f351d8bdc99"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:ae95a868b2cbce464b2b7e065ab4dfaa7"><td class="memItemLeft" align="right" valign="top"><a id="ae95a868b2cbce464b2b7e065ab4dfaa7"></a>
	void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#ae95a868b2cbce464b2b7e065ab4dfaa7">EnableDestStderr</a> (bool enable)</td></tr>
	<tr class="memdesc:ae95a868b2cbce464b2b7e065ab4dfaa7"><td class="mdescLeft"> </td><td class="mdescRight">Disabled by default. <br /></td></tr>
	<tr class="separator:ae95a868b2cbce464b2b7e065ab4dfaa7"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a1b6759cf2879bc0b42dcfdbf3cfed1f0"><td class="memItemLeft" align="right" valign="top"><a id="a1b6759cf2879bc0b42dcfdbf3cfed1f0"></a>
	void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#a1b6759cf2879bc0b42dcfdbf3cfed1f0">EnableDestFile</a> (bool enable)</td></tr>
	<tr class="memdesc:a1b6759cf2879bc0b42dcfdbf3cfed1f0"><td class="mdescLeft"> </td><td class="mdescRight">Enabled by default. <br /></td></tr>
	<tr class="separator:a1b6759cf2879bc0b42dcfdbf3cfed1f0"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a13af9ce49d21bf3b04c198f5580097dd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#a13af9ce49d21bf3b04c198f5580097dd">SetDestFilePath</a> (const std::string &file)</td></tr>
	<tr class="memdesc:a13af9ce49d21bf3b04c198f5580097dd"><td class="mdescLeft"> </td><td class="mdescRight">Reset the output file path. <a href="#a13af9ce49d21bf3b04c198f5580097dd">More...</a><br /></td></tr>
	<tr class="separator:a13af9ce49d21bf3b04c198f5580097dd"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:aa951f405d0cf20944afa5a73c2e166f6"><td class="memItemLeft" align="right" valign="top"><a id="aa951f405d0cf20944afa5a73c2e166f6"></a>
	void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#aa951f405d0cf20944afa5a73c2e166f6">Send</a> (const std::string &message)</td></tr>
	<tr class="memdesc:aa951f405d0cf20944afa5a73c2e166f6"><td class="mdescLeft"> </td><td class="mdescRight">Append a string message. <br /></td></tr>
	<tr class="separator:aa951f405d0cf20944afa5a73c2e166f6"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a306d4777018e397a24abb29468d149d9"><td class="memItemLeft" align="right" valign="top"><a id="a306d4777018e397a24abb29468d149d9"></a>
	void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Channel.html#a306d4777018e397a24abb29468d149d9">Send</a> (const google::protobuf::Message &message)</td></tr>
	<tr class="memdesc:a306d4777018e397a24abb29468d149d9"><td class="mdescLeft"> </td><td class="mdescRight">Append a protobuf message. <br /></td></tr>
	<tr class="separator:a306d4777018e397a24abb29468d149d9"><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 class="el" href="classsinga_1_1Channel.html" title="Channel for appending metrics or other information into files or screen. ">Channel</a> for appending metrics or other information into files or screen. </p>
	</div><h2 class="groupheader">Member Function Documentation</h2>
	<a id="a13af9ce49d21bf3b04c198f5580097dd"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a13af9ce49d21bf3b04c198f5580097dd">◆ </a></span>SetDestFilePath()</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">void singa::Channel::SetDestFilePath </td>
	<td>(</td>
	<td class="paramtype">const std::string & </td>
	<td class="paramname"><em>file</em></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Reset the output file path. </p>
	<p>The dest file is named as global dir + channel name by default. </p>

	</div>
	</div>
	<hr/>The documentation for this class was generated from the following file:<ul>
	<li>/home/moaz/incubator-singa/include/singa/utils/<a class="el" href="channel_8h_source.html">channel.h</a></li>
	</ul>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by  <a href="http://www.doxygen.org/index.html">
	<img class="footer" src="doxygen.png" alt="doxygen"/>
	</a> 1.8.13
	</small></address>
	</body>
	</html>