-
Notifications
You must be signed in to change notification settings - Fork 184
/
Copy path_logging_8h_source.html
176 lines (174 loc) · 17.5 KB
/
_logging_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<!-- HTML header for doxygen 1.8.6-->
<!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.9.1"/>
<title>CombineHarvester: CombineTools/interface/Logging.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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: 70px;">
<td style="padding-left: 0.5em;">
<div id="projectname">CombineHarvester
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_logging_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Logging.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_logging_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef CombineTools_Logging_h</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define CombineTools_Logging_h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <iostream></span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <chrono></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">namespace </span><a class="code" href="namespacech.html">ch</a> {</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="_logging_8h.html#ab140ae8826e1f99c5aa0e920a9c13112"> 9</a></span> <span class="preprocessor">#define FNERROR(x) ch::FnError(x, __FILE__, __LINE__, __PRETTY_FUNCTION__)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="_logging_8h.html#a7c001e91758abea6ce1e5609a873c852"> 11</a></span> <span class="preprocessor">#define LOGLINE(x, y) LogLine(x, __func__, y)</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="_logging_8h.html#ada13f286e68b5dcf51c75365e99c7a68"> 13</a></span> <span class="preprocessor">#define FNLOG(x) x << "["</span> << __func__ << "] "</div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="_logging_8h.html#a3eb848e20af411db5ba7f1d4f082fed0"> 14</a></span> <span class="preprocessor">#define FNLOGC(x, y) if (y) x << "["</span> << __func__ << "] "</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">void</span> <a class="code" href="namespacech.html#a5903f0de2f0d18871f4dab7430d04830">LogLine</a>(std::ostream& stream, std::string <span class="keyword">const</span>& func,</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  std::string <span class="keyword">const</span>& message);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> std::string <a class="code" href="namespacech.html#afdabce9fcf0e565dcd93d273e771ef68">FnError</a>(std::string <span class="keyword">const</span>& message, std::string <span class="keyword">const</span>& file,</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">unsigned</span> line, std::string <span class="keyword">const</span>& fn);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> std::string <a class="code" href="namespacech.html#a082a87dbfd5b9d61198f7fd4b68e70f9">GetQualififedName</a>(std::string <span class="keyword">const</span>& str);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="_logging_8h.html#a877d7811b666826b5f61749fab827a31"> 67</a></span> <span class="preprocessor">#define LAUNCH_FUNCTION_TIMER(x, y) \</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor"> static FnTimer x(ch::GetQualififedName(__PRETTY_FUNCTION__)); \</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"> auto y = x.Inc();</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classch_1_1_fn_timer.html"> 85</a></span> <span class="keyword">class </span><a class="code" href="classch_1_1_fn_timer.html">FnTimer</a> {</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classch_1_1_fn_timer_1_1_token.html"> 87</a></span>  <span class="keyword">class </span><a class="code" href="classch_1_1_fn_timer_1_1_token.html">Token</a> {</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">explicit</span> <a class="code" href="classch_1_1_fn_timer_1_1_token.html#a1c853c1c56a90922270aeaa2727b1fab">Token</a>(<a class="code" href="classch_1_1_fn_timer.html">FnTimer</a> *src);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="classch_1_1_fn_timer_1_1_token.html#a8f09c19cbce557ae83281e8a0c36c8e9">~Token</a>();</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="classch_1_1_fn_timer.html">FnTimer</a> *src_;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  };</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">explicit</span> <a class="code" href="classch_1_1_fn_timer.html#aa6e36b42f8bfa11abc0223da0ff485cc">FnTimer</a>(std::string name);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="classch_1_1_fn_timer.html#ad250e7cf97d91e1fe83d1d861a2fc7ab">~FnTimer</a>();</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="code" href="classch_1_1_fn_timer_1_1_token.html">Token</a> <a class="code" href="classch_1_1_fn_timer.html#a68814f0e60141ebf55f8138f7dbb597d">Inc</a>();</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">void</span> <a class="code" href="classch_1_1_fn_timer.html#aa6368e35ad1520773275baf7ad1bbcb6">StartTimer</a>();</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">void</span> <a class="code" href="classch_1_1_fn_timer.html#a4dc02384a997b93294cd083b107a673e">StopTimer</a>();</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  std::string name_;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">unsigned</span> calls_;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  std::chrono::time_point<std::chrono::system_clock> start_;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  std::chrono::time_point<std::chrono::system_clock> end_;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">double</span> elapsed_;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> };</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> }</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassch_1_1_fn_timer_1_1_token_html"><div class="ttname"><a href="classch_1_1_fn_timer_1_1_token.html">ch::FnTimer::Token</a></div><div class="ttdef"><b>Definition:</b> <a href="_logging_8h_source.html#l00087">Logging.h:87</a></div></div>
<div class="ttc" id="aclassch_1_1_fn_timer_1_1_token_html_a1c853c1c56a90922270aeaa2727b1fab"><div class="ttname"><a href="classch_1_1_fn_timer_1_1_token.html#a1c853c1c56a90922270aeaa2727b1fab">ch::FnTimer::Token::Token</a></div><div class="ttdeci">Token(FnTimer *src)</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8cc_source.html#l00064">Logging.cc:64</a></div></div>
<div class="ttc" id="aclassch_1_1_fn_timer_1_1_token_html_a8f09c19cbce557ae83281e8a0c36c8e9"><div class="ttname"><a href="classch_1_1_fn_timer_1_1_token.html#a8f09c19cbce557ae83281e8a0c36c8e9">ch::FnTimer::Token::~Token</a></div><div class="ttdeci">~Token()</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8cc_source.html#l00065">Logging.cc:65</a></div></div>
<div class="ttc" id="aclassch_1_1_fn_timer_html"><div class="ttname"><a href="classch_1_1_fn_timer.html">ch::FnTimer</a></div><div class="ttdoc">Determine the total amount of time spent in a function.</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8h_source.html#l00085">Logging.h:85</a></div></div>
<div class="ttc" id="aclassch_1_1_fn_timer_html_a4dc02384a997b93294cd083b107a673e"><div class="ttname"><a href="classch_1_1_fn_timer.html#a4dc02384a997b93294cd083b107a673e">ch::FnTimer::StopTimer</a></div><div class="ttdeci">void StopTimer()</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8cc_source.html#l00060">Logging.cc:60</a></div></div>
<div class="ttc" id="aclassch_1_1_fn_timer_html_a68814f0e60141ebf55f8138f7dbb597d"><div class="ttname"><a href="classch_1_1_fn_timer.html#a68814f0e60141ebf55f8138f7dbb597d">ch::FnTimer::Inc</a></div><div class="ttdeci">Token Inc()</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8cc_source.html#l00055">Logging.cc:55</a></div></div>
<div class="ttc" id="aclassch_1_1_fn_timer_html_aa6368e35ad1520773275baf7ad1bbcb6"><div class="ttname"><a href="classch_1_1_fn_timer.html#aa6368e35ad1520773275baf7ad1bbcb6">ch::FnTimer::StartTimer</a></div><div class="ttdeci">void StartTimer()</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8cc_source.html#l00059">Logging.cc:59</a></div></div>
<div class="ttc" id="aclassch_1_1_fn_timer_html_aa6e36b42f8bfa11abc0223da0ff485cc"><div class="ttname"><a href="classch_1_1_fn_timer.html#aa6e36b42f8bfa11abc0223da0ff485cc">ch::FnTimer::FnTimer</a></div><div class="ttdeci">FnTimer(std::string name)</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8cc_source.html#l00049">Logging.cc:49</a></div></div>
<div class="ttc" id="aclassch_1_1_fn_timer_html_ad250e7cf97d91e1fe83d1d861a2fc7ab"><div class="ttname"><a href="classch_1_1_fn_timer.html#ad250e7cf97d91e1fe83d1d861a2fc7ab">ch::FnTimer::~FnTimer</a></div><div class="ttdeci">~FnTimer()</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8cc_source.html#l00050">Logging.cc:50</a></div></div>
<div class="ttc" id="anamespacech_html"><div class="ttname"><a href="namespacech.html">ch</a></div><div class="ttdef"><b>Definition:</b> <a href="_algorithm_8h_source.html#l00010">Algorithm.h:10</a></div></div>
<div class="ttc" id="anamespacech_html_a082a87dbfd5b9d61198f7fd4b68e70f9"><div class="ttname"><a href="namespacech.html#a082a87dbfd5b9d61198f7fd4b68e70f9">ch::GetQualififedName</a></div><div class="ttdeci">std::string GetQualififedName(std::string const &str)</div><div class="ttdoc">Extracts the fully-qualified function name from a complete function signature.</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8cc_source.html#l00008">Logging.cc:8</a></div></div>
<div class="ttc" id="anamespacech_html_a5903f0de2f0d18871f4dab7430d04830"><div class="ttname"><a href="namespacech.html#a5903f0de2f0d18871f4dab7430d04830">ch::LogLine</a></div><div class="ttdeci">void LogLine(std::ostream &stream, std::string const &func, std::string const &message)</div><div class="ttdoc">Writes a logging message to a given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8cc_source.html#l00027">Logging.cc:27</a></div></div>
<div class="ttc" id="anamespacech_html_afdabce9fcf0e565dcd93d273e771ef68"><div class="ttname"><a href="namespacech.html#afdabce9fcf0e565dcd93d273e771ef68">ch::FnError</a></div><div class="ttdeci">std::string FnError(std::string const &message, std::string const &file, unsigned line, std::string const &fn)</div><div class="ttdoc">Generates an error message which includes the name of the calling function and the filename and line ...</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8cc_source.html#l00032">Logging.cc:32</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
</body>
</html>