1 karl  1.20 //%2006////////////////////////////////////////////////////////////////////////

  2 mike  1.12 //

  3 karl  1.16 // 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 karl  1.15 // IBM Corp.; EMC Corporation, The Open Group.

  7 karl  1.16 // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
  8            // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

  9 karl  1.17 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10            // EMC Corporation; VERITAS Software Corporation; The Open Group.

 11 karl  1.20 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12            // EMC Corporation; Symantec Corporation; The Open Group.

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

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

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

 20 karl  1.20 // 

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

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

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

 27 mike  1.12 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 28            // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 29            //
 30            //==============================================================================
 31            //
 32            // Author: Mike Brasher (mbrasher@bmc.com)
 33            //
 34            // Modified By:

 35 chip  1.18 //      Chip Vincent (cvincent@us.ibm.com)

 36 mike  1.12 //
 37            //%/////////////////////////////////////////////////////////////////////////////
 38            
 39            #ifndef Pegasus_Stopwatch_h
 40            #define Pegasus_Stopwatch_h
 41            
 42            #include <Pegasus/Common/Config.h>

 43 chip  1.18 

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

 45 mike  1.12 
 46            PEGASUS_NAMESPACE_BEGIN
 47            
 48            /** Stopwatch - A class for measuring elapsed time

 49 chip  1.18     Stopwatch is a class for measuring time intervals within the environment.

 50 mike  1.12     It is intended to be a developers tool primarily.
 51            */
 52            class PEGASUS_COMMON_LINKAGE Stopwatch
 53            {
 54            public:
 55            

 56 chip  1.18     /** constructor. The constructor creates the object. Start
 57                must be called to start the timer.

 58 mike  1.12     @example Stopwatch time;
 59                */

 60 chip  1.18     Stopwatch(void);
 61            
 62                /** start - Starts accumulating time and continues until stop is called.
 63                The object can be started and stopped multiple times to measure the
 64                sum of several intervals, but each start must have a corresponding start.
 65                */
 66                void start(void);

 67 mike  1.12 

 68 chip  1.18     /** stop - Stops the accumlation of time for an interval. The object
 69                should only stopped if it has been started.

 70 mike  1.12     */

 71 chip  1.18     void stop(void);

 72 mike  1.12 

 73 chip  1.18     /** reset - Effectively clears the time values stored by a Stopwatch.
 74                */
 75                void reset(void);
 76            
 77                /** getElapsed - Get the elapsed time for the defined stopwatch. This
 78                method should only be called if it is currently stopped.

 79 jim.wunderlich 1.19     @return Returns the elapsed time value as a double (in milliseconds).

 80 mike           1.12     */

 81 chip           1.18     double getElapsed(void) const;

 82 mike           1.12 

 83 jim.wunderlich 1.19     /** Get number of elapsed microseconds
 84                         */
 85                         Uint64 getElapsedUsec(void) const;
 86                     

 87 chip           1.18     /** printElapsed method gets the current value of the timer and
 88                         sends it to standard out as a string with the word seconds attached

 89 mike           1.12     */

 90 chip           1.18     void printElapsed(void);
 91                     
 92                     private:

 93 jim.wunderlich 1.19     Uint64 _start;
 94                         Uint64 _stop;
 95                         Uint64 _total;

 96 mike           1.12 };
 97                     
 98                     PEGASUS_NAMESPACE_END
 99                     
100                     #endif /* Pegasus_Stopwatch_h */