1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkResourceProbesCollectorBase_h
#define itkResourceProbesCollectorBase_h
#include "itkResourceProbe.h"
#include "itkMemoryUsageObserver.h"
namespace itk
{
/** \class ResourceProbesCollectorBase
* \brief Aggregates a set of probes.
*
* This class defines a set of ResourceProbes and assign names to them.
* The user can start and stop each one of the probes by addressing them by name.
*
* \sa ResourceProbe
*
* \ingroup ITKCommon
*/
template <typename TProbe>
class ITK_TEMPLATE_EXPORT ResourceProbesCollectorBase
{
public:
using IdType = std::string;
using MapType = std::map<IdType, TProbe>;
/** destructor */
virtual ~ResourceProbesCollectorBase() = default;
/** Start a probe with a particular name. If the time probe does not
* exist, it will be created */
virtual void
Start(const char * id);
/** Stop a time probe identified with a name */
virtual void
Stop(const char * id);
/** Report the summary of results from all probes */
virtual void
Report(std::ostream & os = std::cout, bool printSystemInfo = true, bool printReportHead = true, bool useTabs = false);
/** Report the summary of results from a specific probe */
virtual void
Report(const char * name,
std::ostream & os = std::cout,
bool printSystemInfo = true,
bool printReportHead = true,
bool useTabs = false);
/** Expanded report of the summary of results from all probes */
virtual void
ExpandedReport(std::ostream & os = std::cout,
bool printSystemInfo = true,
bool printReportHead = true,
bool useTabs = false);
/** Expanded report of the summary of results from a specific probe */
virtual void
ExpandedReport(const char * name,
std::ostream & os = std::cout,
bool printSystemInfo = true,
bool printReportHead = true,
bool useTabs = false);
/** JavaScript Object Notation (JSON) expanded report the summary of results from all probes */
virtual void
JSONReport(std::ostream & os = std::cout, bool printSystemInfo = true);
/** JavaScript Object Notation (JSON) expanded report the summary of results from a specific probe */
virtual void
JSONReport(const char * name, std::ostream & os = std::cout);
/** Destroy the set of probes. New probes can be created after invoking this
method. */
virtual void
Clear();
/** Returns a named Probe. If the name does not exists an exception
* is thrown. */
const TProbe &
GetProbe(const char * id) const;
protected:
MapType m_Probes{};
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkResourceProbesCollectorBase.hxx"
#endif
#endif // itkResourceProbesCollectorBase_h
|
