1 mike  1.12 //%/////////////////////////////////////////////////////////////////////////////
 2            //

 3 kumpf 1.13 // Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM,
 4            // The Open Group, Tivoli Systems

 5 mike  1.12 //
 6            // Permission is hereby granted, free of charge, to any person obtaining a copy

 7 kumpf 1.13 // of this software and associated documentation files (the "Software"), to
 8            // deal in the Software without restriction, including without limitation the
 9            // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

10 mike  1.12 // sell copies of the Software, and to permit persons to whom the Software is
11            // furnished to do so, subject to the following conditions:
12            // 

13 kumpf 1.13 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

14 mike  1.12 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
15            // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

16 kumpf 1.13 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
17            // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
18            // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

19 mike  1.12 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20            // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21            //
22            //==============================================================================
23            //
24            // Author: Mike Brasher (mbrasher@bmc.com)
25            //
26            // Modified By:
27            //
28            //%/////////////////////////////////////////////////////////////////////////////
29            
30            #ifndef Pegasus_Stopwatch_h
31            #define Pegasus_Stopwatch_h
32            
33            #include <Pegasus/Common/Config.h>
34            #include <Pegasus/Common/TimeValue.h>
35            #include <Pegasus/Common/System.h>

36 kumpf 1.14 #include <Pegasus/Common/Linkage.h>

37 mike  1.12 
38            PEGASUS_NAMESPACE_BEGIN
39            
40            /** Stopwatch - A class for measuring elapsed time
41                Stopwatch is a class for measuring time intervals within the environment. 
42                It is intended to be a developers tool primarily.
43            */
44            class PEGASUS_COMMON_LINKAGE Stopwatch
45            {
46            private:
47                TimeValue _start;
48            
49            public:
50            
51                /**	stopwatch constructor. The constructor creates the object and
52                starts the timer
53                @example Stopwatch time;
54                */
55                Stopwatch();
56            
57                /**	Reset Stopwatch	resets an existing Stopwatch object to the 
58 mike  1.12     current time value
59                */
60                void reset();
61            
62                /**	getElapsed - Get the elapsed time for the defined stopwatch.
63                @return Returns the elapsed time value as a double
64                */
65                double getElapsed() const;
66            
67                /**	printElapsed method gets the current value of the timer and
68                sends it to standardout as a string with the word seconds attached
69                */
70                void printElapsed();
71            };
72            
73            PEGASUS_NAMESPACE_END
74            
75            #endif /* Pegasus_Stopwatch_h */