summaryrefslogtreecommitdiff
path: root/docs/CAmLog_8h.html
blob: 88d5f14c6370c9288a883ff163ef27d3da87bf6f (plain)
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
<!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.11"/>
<title>AudioManager: AudioManagerCore/include/CAmLog.h File 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);
  $(window).load(resizeHeight);
</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">
  $(document).ready(function() { init_search(); });
</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">AudioManager
   &#160;<span id="projectnumber">7.6.6</span>
   </div>
   <div id="projectbrief">Native Application Runtime Environment</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#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('CAmLog_8h.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)">
</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="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">CAmLog.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>SPDX license identifier: MPL-2.0.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;iosfwd&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdexcept&gt;</code><br />
<code>#include &lt;fstream&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;sstream&gt;</code><br />
<code>#include &lt;assert.h&gt;</code><br />
</div>
<p><a href="CAmLog_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAmLog.html">CAmLog</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a1bff47dabd24fb71fb5d87cfc0b0bdef"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CAmLog_8h.html#a1bff47dabd24fb71fb5d87cfc0b0bdef">DEFAULT_LOG_FOLDER</a>&#160;&#160;&#160;&quot;/tmp/&quot;</td></tr>
<tr class="memdesc:a1bff47dabd24fb71fb5d87cfc0b0bdef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements a basic logging mechanism that can be used to print debug information into a file or to the console.  <a href="#a1bff47dabd24fb71fb5d87cfc0b0bdef">More...</a><br /></td></tr>
<tr class="separator:a1bff47dabd24fb71fb5d87cfc0b0bdef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a026c614b810f6e9438f1dea224a85b4c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CAmLog_8h.html#a026c614b810f6e9438f1dea224a85b4c">DEFAULT_LOGFILE_PREFIX</a>&#160;&#160;&#160;&quot;am_dump_&quot;</td></tr>
<tr class="separator:a026c614b810f6e9438f1dea224a85b4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55d8de1f1fb579e18fe00fca209750b1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CAmLog_8h.html#a55d8de1f1fb579e18fe00fca209750b1">DEFAULT_LOGFILE_EXT</a>&#160;&#160;&#160;&quot;.log&quot;</td></tr>
<tr class="separator:a55d8de1f1fb579e18fe00fca209750b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7254c26da5762c03c4825d6b74d490d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CAmLog_8h.html#ad7254c26da5762c03c4825d6b74d490d">DEL</a>(aPointer)&#160;&#160;&#160;delete aPointer, aPointer = NULL;</td></tr>
<tr class="separator:ad7254c26da5762c03c4825d6b74d490d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5edb2739b8b6363c90e1e7b4d782ceef"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CAmLog_8h.html#a5edb2739b8b6363c90e1e7b4d782ceef">CAmLogger</a>&#160;&#160;&#160;(*<a class="el" href="classCAmLog.html#a6d6754c07a4a6e62f667ca6249d4b3c6">CAmLog::getDefaultLog</a>())</td></tr>
<tr class="separator:a5edb2739b8b6363c90e1e7b4d782ceef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:acab6e77c85e55db7aaaf626798706060"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CAmLog_8h.html#acab6e77c85e55db7aaaf626798706060">eCAmLogType</a> { <a class="el" href="CAmLog_8h.html#acab6e77c85e55db7aaaf626798706060a631300b7150692fe453fe22efe1a9743">eCAmLogNone</a> = 0, 
<a class="el" href="CAmLog_8h.html#acab6e77c85e55db7aaaf626798706060a23deb73b2b9522c173562156d07a01a3">eCAmLogStdout</a> = 1, 
<a class="el" href="CAmLog_8h.html#acab6e77c85e55db7aaaf626798706060a1635863cf2915677d715a44105d4f485">eCAmLogFile</a> = 2
 }</td></tr>
<tr class="separator:acab6e77c85e55db7aaaf626798706060"><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>SPDX license identifier: MPL-2.0. </p>
<p>Copyright (C) 2012, BMW AG</p>
<p>This file is part of GENIVI Project AudioManager.</p>
<p>Contributions are licensed to the GENIVI Alliance under one or more Contribution License Agreements.</p>
<dl class="section copyright"><dt>Copyright</dt><dd>This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>.</dd></dl>
<dl class="section author"><dt>Author</dt><dd>Aleksandar Donchev, <a href="#" onclick="location.href='mai'+'lto:'+'ale'+'ks'+'and'+'er'+'.do'+'nc'+'hev'+'@p'+'art'+'ne'+'r.b'+'mw'+'.de'; return false;">aleks<span style="display: none;">.nosp@m.</span>ande<span style="display: none;">.nosp@m.</span>r.don<span style="display: none;">.nosp@m.</span>chev<span style="display: none;">.nosp@m.</span>@part<span style="display: none;">.nosp@m.</span>ner.<span style="display: none;">.nosp@m.</span>bmw.d<span style="display: none;">.nosp@m.</span>e</a> BMW 2013</dd></dl>
<p>For further information see <a href="http://www.genivi.org/">http://www.genivi.org/</a>. </p>

<p>Definition in file <a class="el" href="CAmLog_8h_source.html">CAmLog.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a5edb2739b8b6363c90e1e7b4d782ceef"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CAmLogger&#160;&#160;&#160;(*<a class="el" href="classCAmLog.html#a6d6754c07a4a6e62f667ca6249d4b3c6">CAmLog::getDefaultLog</a>())</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="CAmLog_8h_source.html#l00126">126</a> of file <a class="el" href="CAmLog_8h_source.html">CAmLog.h</a>.</p>

</div>
</div>
<a class="anchor" id="a1bff47dabd24fb71fb5d87cfc0b0bdef"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DEFAULT_LOG_FOLDER&#160;&#160;&#160;&quot;/tmp/&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Implements a basic logging mechanism that can be used to print debug information into a file or to the console. </p>
<p>It can be used either as singleton through the appropriate method getDefaultLog() or as independent instantiated object. The default initializer sets the console as output for newly created objects. Example: CAmLogger &lt;&lt; "Text"; //to print out through the singleton object directly to the console </p>

<p>Definition at line <a class="el" href="CAmLog_8h_source.html#l00043">43</a> of file <a class="el" href="CAmLog_8h_source.html">CAmLog.h</a>.</p>

</div>
</div>
<a class="anchor" id="a55d8de1f1fb579e18fe00fca209750b1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DEFAULT_LOGFILE_EXT&#160;&#160;&#160;&quot;.log&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="CAmLog_8h_source.html#l00045">45</a> of file <a class="el" href="CAmLog_8h_source.html">CAmLog.h</a>.</p>

</div>
</div>
<a class="anchor" id="a026c614b810f6e9438f1dea224a85b4c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DEFAULT_LOGFILE_PREFIX&#160;&#160;&#160;&quot;am_dump_&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="CAmLog_8h_source.html#l00044">44</a> of file <a class="el" href="CAmLog_8h_source.html">CAmLog.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad7254c26da5762c03c4825d6b74d490d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DEL</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">aPointer</td><td>)</td>
          <td>&#160;&#160;&#160;delete aPointer, aPointer = NULL;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="CAmLog_8h_source.html#l00047">47</a> of file <a class="el" href="CAmLog_8h_source.html">CAmLog.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="acab6e77c85e55db7aaaf626798706060"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="CAmLog_8h.html#acab6e77c85e55db7aaaf626798706060">eCAmLogType</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="acab6e77c85e55db7aaaf626798706060a631300b7150692fe453fe22efe1a9743"></a>eCAmLogNone&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="acab6e77c85e55db7aaaf626798706060a23deb73b2b9522c173562156d07a01a3"></a>eCAmLogStdout&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="acab6e77c85e55db7aaaf626798706060a1635863cf2915677d715a44105d4f485"></a>eCAmLogFile&#160;</td><td class="fielddoc">
</td></tr>
</table>

<p>Definition at line <a class="el" href="CAmLog_8h_source.html#l00050">50</a> of file <a class="el" href="CAmLog_8h_source.html">CAmLog.h</a>.</p>

</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="dir_73840c26962c025d9d91b16130beda5a.html">AudioManagerCore</a></li><li class="navelem"><a class="el" href="dir_a2790e911832141e38a92850240f8218.html">include</a></li><li class="navelem"><a class="el" href="CAmLog_8h.html">CAmLog.h</a></li>
    <li class="footer">Generated on Fri Feb 9 2018 14:50:30 for AudioManager by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>