1 /*=========================================================================
2  *
3  *  Copyright Insight Software Consortium
4  *
5  *  Licensed under the Apache License, Version 2.0 (the "License");
6  *  you may not use this file except in compliance with the License.
7  *  You may obtain a copy of the License at
8  *
9  *         http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  *  Unless required by applicable law or agreed to in writing, software
12  *  distributed under the License is distributed on an "AS IS" BASIS,
13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  *  See the License for the specific language governing permissions and
15  *  limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkTimeProbe_h
19 #define itkTimeProbe_h
20 
21 #include "itkConfigure.h"
22 #include "itkResourceProbe.h"
23 #include "itkRealTimeClock.h"
24 
25 namespace itk
26 {
27 /** \class TimeProbe
28  *
29  *  \brief Computes the time passed between two points in code.
30  *
31  *   This class allows the user to trace the time passed between the execution
32  *   of two pieces of code.  It can be started and stopped in order to evaluate
33  *   the execution over multiple passes.  The values of time are taken from the
34  *   RealTimeClock.
35  *
36  *   \sa RealTimeClock
37  *
38  * \ingroup ITKCommon
39  *
40  * \wiki
41  * \wikiexample{Utilities/TimeProbe,Time probe}
42  * \endwiki
43  */
44 class ITKCommon_EXPORT TimeProbe:public
45   ResourceProbe< RealTimeClock::TimeStampType, RealTimeClock::TimeStampType >
46 {
47 public:
48 
49   /** Type for counting how many times the probe has been started and stopped.
50     */
51   using CountType = unsigned long;
52 
53   /** Type for measuring time. See the RealTimeClock class for details on the
54    * precision and units of this clock signal */
55   using TimeStampType = RealTimeClock::TimeStampType;
56 
57 public:
58 
59   /** Constructor */
60   TimeProbe();
61 
62   /** Destructor */
63   ~TimeProbe() override;
64 
65   /** Get the current time.
66    *  Warning: the returned value is not the elapsed time since the last Start() call.
67    */
68   TimeStampType GetInstantValue() const override;
69 
70   /** Get a handle to m_RealTimeClock. */
71   itkGetConstObjectMacro( RealTimeClock, RealTimeClock );
72 
73 private:
74   RealTimeClock::Pointer m_RealTimeClock;
75 };
76 } // end namespace itk
77 
78 #endif //itkTimeProbe_h
79