From 1111f28e3693ee0f296819654a5c35fe147c395d Mon Sep 17 00:00:00 2001 From: Christian as GENIVI Maintainer Date: Fri, 30 Sep 2016 08:11:30 -0700 Subject: add doxygen documentation for github Signed-off-by: Christian as GENIVI Maintainer --- docs/CAmDltWrapper_8h.html | 372 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 372 insertions(+) create mode 100644 docs/CAmDltWrapper_8h.html (limited to 'docs/CAmDltWrapper_8h.html') diff --git a/docs/CAmDltWrapper_8h.html b/docs/CAmDltWrapper_8h.html new file mode 100644 index 0000000..c951dfc --- /dev/null +++ b/docs/CAmDltWrapper_8h.html @@ -0,0 +1,372 @@ + + + + + + +AudioManager: AudioManagerUtilities/include/CAmDltWrapper.h File Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
AudioManager +  7.5.11 +
+
Native Application Runtime Environment
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Classes | +Namespaces | +Macros | +Enumerations | +Functions
+
+
CAmDltWrapper.h File Reference
+
+
+ +

SPDX license identifier: MPL-2.0. +More...

+
#include <string>
+#include <pthread.h>
+#include <sstream>
+#include <iostream>
+#include <fstream>
+#include <map>
+#include <vector>
+#include <audiomanagerconfig.h>
+#include "audiomanagertypes.h"
+#include <stdint.h>
+
+

Go to the source code of this file.

+ + + + + + + + + + + + + + +

+Classes

struct  DltContext
 This structure is used for every context used in an application. More...
 
struct  DltContextData
 This structure is used for context data used in an application. More...
 
class  am::CAmDltWrapper
 Wraps around the dlt. More...
 
struct  am::CAmDltWrapper::NoDltContextData
 This structure is used for context data used in an application. More...
 
+ + + + +

+Namespaces

 am
 A Common-API wrapper class, which loads the common-api runtime and instantiates all necessary objects.
 
+ + + + + + + + + +

+Macros

#define DLT_USER_BUF_MAX_SIZE   2048
 
#define DLT_DEFAULT_LOG_LEVEL   DLT_LOG_INFO
 
#define DLT_DECLARE_CONTEXT(CONTEXT)   DltContext CONTEXT;
 
#define DLT_IMPORT_CONTEXT(CONTEXT)   extern DltContext CONTEXT;
 
+ + + + + + + +

+Enumerations

enum  DltTraceStatusType { DLT_TRACE_STATUS_DEFAULT = -1, +DLT_TRACE_STATUS_OFF = 0x00, +DLT_TRACE_STATUS_ON = 0x01 + }
 Definition of DLT trace status. More...
 
enum  DltLogLevelType {
+  DLT_LOG_DEFAULT = -1, +DLT_LOG_OFF = 0x00, +DLT_LOG_FATAL = 0x01, +DLT_LOG_ERROR = 0x02, +
+  DLT_LOG_WARN = 0x03, +DLT_LOG_INFO = 0x04, +DLT_LOG_DEBUG = 0x05, +DLT_LOG_VERBOSE = 0x06 +
+ }
 Definitions of DLT log level. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

template<typename T , typename... TArgs>
void am::log (DltContext *const context, DltLogLevelType loglevel, T value, TArgs...args)
 logs given values with a given context (register first!) and given loglevel More...
 
template<typename T , typename... TArgs>
void am::logDebug (T value, TArgs...args)
 logs given values with debuglevel with the default context More...
 
template<typename T , typename... TArgs>
void am::logInfo (T value, TArgs...args)
 logs given values with infolevel with the default context More...
 
template<typename T , typename... TArgs>
void am::logError (T value, TArgs...args)
 logs given values with errorlevel with the default context More...
 
template<typename T , typename... TArgs>
void am::logWarning (T value, TArgs...args)
 logs given values with warninglevel with the default context More...
 
template<typename T , typename... TArgs>
void am::logVerbose (T value, TArgs...args)
 logs given values with verbose with the default context More...
 
+

Detailed Description

+

SPDX license identifier: MPL-2.0.

+

Copyright (C) 2012, BMW AG

+
Author
Christian Linke, chris.nosp@m.tian.nosp@m..link.nosp@m.e@bm.nosp@m.w.de BMW 2011,2012
+
+Jens Lorenz, jlore.nosp@m.nz@d.nosp@m.e.adi.nosp@m.t-jv.nosp@m..com ADIT 2014
+
Copyright
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 http://mozilla.org/MPL/2.0/.
+

For further information see http://www.genivi.org/.

+ +

Definition in file CAmDltWrapper.h.

+

Macro Definition Documentation

+ +
+
+ + + + + + + + +
#define DLT_DECLARE_CONTEXT( CONTEXT)   DltContext CONTEXT;
+
+ +

Definition at line 89 of file CAmDltWrapper.h.

+ +
+
+ +
+
+ + + + +
#define DLT_DEFAULT_LOG_LEVEL   DLT_LOG_INFO
+
+ +

Definition at line 88 of file CAmDltWrapper.h.

+ +
+
+ +
+
+ + + + + + + + +
#define DLT_IMPORT_CONTEXT( CONTEXT)   extern DltContext CONTEXT;
+
+ +

Definition at line 92 of file CAmDltWrapper.h.

+ +
+
+ +
+
+ + + + +
#define DLT_USER_BUF_MAX_SIZE   2048
+
+ +

Definition at line 37 of file CAmDltWrapper.h.

+ +
+
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum DltLogLevelType
+
+ +

Definitions of DLT log level.

+ + + + + + + + + +
Enumerator
DLT_LOG_DEFAULT  +

Default log level.

+
DLT_LOG_OFF  +

Log level off.

+
DLT_LOG_FATAL  +

fatal system error

+
DLT_LOG_ERROR  +

error with impact to correct functionality

+
DLT_LOG_WARN  +

warning, correct behaviour could not be ensured

+
DLT_LOG_INFO  +

informational

+
DLT_LOG_DEBUG  +

debug

+
DLT_LOG_VERBOSE  +

highest grade of information

+
+ +

Definition at line 76 of file CAmDltWrapper.h.

+ +
+
+ +
+
+ + + + +
enum DltTraceStatusType
+
+ +

Definition of DLT trace status.

+ + + + +
Enumerator
DLT_TRACE_STATUS_DEFAULT  +

Default trace status.

+
DLT_TRACE_STATUS_OFF  +

Trace status: Off.

+
DLT_TRACE_STATUS_ON  +

Trace status: On.

+
+ +

Definition at line 52 of file CAmDltWrapper.h.

+ +
+
+
+
+ + + + -- cgit v1.2.1