1 karl  1.15 //%2003////////////////////////////////////////////////////////////////////////

 2 mike  1.12 //

 3 karl  1.15 // Copyright (c) 2000, 2001, 2002  BMC Software, Hewlett-Packard Development
 4            // Company, L. P., IBM Corp., The Open Group, Tivoli Systems.
 5            // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.;
 6            // IBM Corp.; EMC Corporation, The Open Group.

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

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

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

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

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

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

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

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

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