| OpenMS 2.5.0

FileWatcher.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2020.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34
35
36 #pragma once
37
38 //OpenMS
39 #include <OpenMS/CONCEPT/Types.h>
40 #include <OpenMS/DATASTRUCTURES/Map.h>
41 #include <OpenMS/DATASTRUCTURES/String.h>
42
43 //Qt
44 #include <QtCore/QFileSystemWatcher>
45
46 //STL
47 #include <map>
48
49 namespace OpenMS
50 {
51 class String;
52
65 class FileWatcher :
66 public QFileSystemWatcher //find out why ICC requires public instead of protected
67 {
68 Q_OBJECT
69
70 public:
72 OPENMS_DLLAPI FileWatcher(QObject * parent = nullptr);
73
75 OPENMS_DLLAPI ~FileWatcher() override;
76
78 inline void setDelayInSeconds(double delay)
79 {
80 delay_in_seconds_ = delay;
81 }
82
84 inline void addFile(const String & path)
85 {
86 QFileSystemWatcher::addPath(path.toQString());
87 }
88
90 inline void removeFile(const String & path)
91 {
92 QFileSystemWatcher::removePath(path.toQString());
93 }
94
95 signals:
97 OPENMS_DLLAPI void fileChanged(const String &);
98
99 protected slots:
101 OPENMS_DLLAPI void monitorFileChanged_(const QString & name);
103 OPENMS_DLLAPI void timerTriggered_();
104
105 protected:
107 Map<QString, QString> timers_;
109 double delay_in_seconds_;
110 };
111
112 // OPENMS_DLLAPI extern FileWatcher myFileWatcher_instance;
113 }
114
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::FileWatcher::timers_
Map< QString, QString > timers_
A map that links timer name and file.
Definition: FileWatcher.h:107
OpenMS::FileWatcher::removeFile
void removeFile(const String &path)
removes a file from the watcher
Definition: FileWatcher.h:90
OpenMS::FileWatcher::~FileWatcher
~FileWatcher() override
Destructor.
OpenMS::FileWatcher::timerTriggered_
void timerTriggered_()
Slot that is called when the delay is over.
QFileSystemWatcher
OpenMS::FileWatcher
Watcher that monitors file changes.
Definition: FileWatcher.h:65
Types.h
OpenMS::FileWatcher::fileChanged
void fileChanged(const String &)
Delayed file change signal.
String.h
OpenMS::Map< QString, QString >
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::FileWatcher::setDelayInSeconds
void setDelayInSeconds(double delay)
Sets the delay in seconds (default: 1s)
Definition: FileWatcher.h:78
Map.h
OpenMS::FileWatcher::delay_in_seconds_
double delay_in_seconds_
Delay (seconds)
Definition: FileWatcher.h:109
OpenMS::FileWatcher::addFile
void addFile(const String &path)
Adds a file to the watcher.
Definition: FileWatcher.h:84
OpenMS::FileWatcher::monitorFileChanged_
void monitorFileChanged_(const QString &name)
Slot that is connected to the fileChanged signal in order to track the changes.
OpenMS::FileWatcher::FileWatcher
FileWatcher(QObject *parent=nullptr)
Constructor.
QObject
OpenMS::String::toQString
QString toQString() const
Conversion to Qt QString.