Developer Documentation
PluginLogging.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 
43 
44 
45 
46 
47 //=============================================================================
48 //
49 // Logging System
50 //
51 //=============================================================================
52 
53 #pragma once
54 
55 //=============================================================== INCLUDES ====
56 
57 #include <iostream>
58 
59 #include <QObject>
61 
62 //======================================================= CLASS DEFINITION ====
73 class PluginLogger : public QObject {
74 
75  Q_OBJECT
76 
77  public:
78 
80  PluginLogger(QString _pluginName , Logtype _type = LOGOUT);
81 
83  ~PluginLogger();
84 
86  void operator<< ( const std::string& _s );
87 
88  private slots:
89 
91  void slotLog(Logtype _type, QString _message);
92 
94  void slotLog(QString _message);
95 
96  signals:
98  void log(Logtype , QString);
99 
100  private:
102  QString pluginName_;
103 
106 
107 };
108 
109 
110 //=============================================================================
Logtype
Log types for Message Window.
PluginLogger(QString _pluginName, Logtype _type=LOGOUT)
Standard Constructor.
~PluginLogger()
Destructor.
void slotLog(Logtype _type, QString _message)
Log messages with a given Logtype.
QString pluginName_
prepend this name to all output messages
void log(Logtype, QString)
Sends the generated logs to the core.
void operator<<(const std::string &_s)
Provide operator for streaming.
Logtype defaultLogType_
Default logtype ( used for streams )