| OpenMS 2.5.0

SysInfo.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: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/config.h>
38 #include <OpenMS/DATASTRUCTURES/String.h>
39
40 namespace OpenMS
41 {
42
49 class OPENMS_DLLAPI SysInfo
50 {
51 public:
58 static bool getProcessMemoryConsumption(size_t& mem_virtual);
59
66 static bool getProcessPeakMemoryConsumption(size_t& mem_virtual);
67
83 struct OPENMS_DLLAPI MemUsage
84 {
85 size_t mem_before, mem_before_peak, mem_after, mem_after_peak;
86
88 MemUsage();
89
91 void reset();
93 void before();
95 void after();
98 String delta(const String& event = "delta");
99
102 String usage();
103
104 private:
105 // convert difference to string
106 String diff_str_(size_t mem_before, size_t mem_after);
107
108 };
109 };
110 }
111
OpenMS::SysInfo::MemUsage::mem_before_peak
size_t mem_before_peak
Definition: SysInfo.h:85
OpenMS::SysInfo::MemUsage
A convenience class to report either absolute or delta (between two timepoints) RAM usage...
Definition: SysInfo.h:83
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::SysInfo
Some functions to get system information.
Definition: SysInfo.h:49
String.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46