Developer Documentation

MemInfo.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 #pragma once
43
44 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
45 #include <OpenFlipper/BasePlugin/LoggingInterface.hh>
46 #include <OpenFlipper/BasePlugin/StatusbarInterface.hh>
47
48 #include <QProgressBar>
49
50 class MemInfoPlugin: public QObject, BaseInterface, LoggingInterface, StatusbarInterface {
51 Q_OBJECT
52 Q_INTERFACES(BaseInterface)
53 Q_INTERFACES(LoggingInterface)
54 Q_INTERFACES(StatusbarInterface)
55
56 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-MemInfo")
57
58 signals:
59
60 // LoggingInterface
61 void log(Logtype _type, QString _message);
62 void log(QString _message);
63
64 // StatusbarInterface
65 void addWidgetToStatusbar(QWidget* _widget);
66
67 public:
68 MemInfoPlugin();
69 ~MemInfoPlugin();
70
71 // BaseInterface
72 QString name() { return (QString("MemInfo")); } ;
73 QString description() { return (QString("Plugin used to display current GPU/CPU Memory Status")); } ;
74
75 private slots:
76
78 void initializePlugin();
79 void pluginsInitialized();
80
81
83 void nvidiaMemoryInfoUpdate();
84
86 void cpuMemoryInfoUpdate();
87
88 private:
89
91 void setProgressBarStyleSheet(QProgressBar* _bar);
92
94 QProgressBar* gpuMemBar_;
95
97 QProgressBar* mainMemBar_;
98
100 QTimer* updateTimer_;
101
102 public slots:
103
104 QString version() { return QString("1.0"); };
105
106 };
MemInfoPlugin::nvidiaMemoryInfoUpdate
void nvidiaMemoryInfoUpdate()
Update statusbar with NVIDIA memory infos.
Definition: MemInfo.cc:120
MemInfoPlugin::initializePlugin
void initializePlugin()
BaseInterface.
Definition: MemInfo.cc:53
Logtype
Logtype
Log types for Message Window.
Definition: LoggingInterface.hh:92
StatusbarInterface
Control OpenFlippers status bar.
Definition: StatusbarInterface.hh:81
MemInfoPlugin::mainMemBar_
QProgressBar * mainMemBar_
Status bar for Main memory.
Definition: MemInfo.hh:97
LoggingInterface.hh
MemInfoPlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: MemInfo.hh:73
LoggingInterface
Interface for all Plugins which do logging to the logging window of the framework.
Definition: LoggingInterface.hh:112
MemInfoPlugin::updateTimer_
QTimer * updateTimer_
Timer that triggers an update of the bars.
Definition: MemInfo.hh:100
MemInfoPlugin::name
QString name()
Return a name for the plugin.
Definition: MemInfo.hh:72
BaseInterface.hh
MemInfoPlugin
Definition: MemInfo.hh:50
MemInfoPlugin::gpuMemBar_
QProgressBar * gpuMemBar_
Status bar for GPU memory.
Definition: MemInfo.hh:94
MemInfoPlugin::setProgressBarStyleSheet
void setProgressBarStyleSheet(QProgressBar *_bar)
Sets the Qt Stylesheet for the progress bars.
Definition: MemInfo.cc:150
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
MemInfoPlugin::cpuMemoryInfoUpdate
void cpuMemoryInfoUpdate()
Update statusbar with main memory infos.
Definition: MemInfo.cc:137
StatusbarInterface.hh