mtimer.h

Go to the documentation of this file.

/**
 * \file mtimer.h <mi32/mtimer.h>
 * \brief Header file for MTIMER class
 *
 * \if NODOC
 * $Id: mtimer.h_v 1.6 2004/02/16 21:01:45 mju Exp $
 *
 * $Log: mtimer.h_v $
 * Revision 1.6  2004/02/16 21:01:45  mju
 * Warn on deprecated usage.
 *
 * Revision 1.5  2003/10/27 16:26:12  dwilliss
 * Fixed Mike's deprecatation.   Have to allow the prototype to exist if
 * compiling misystem
 *
 * Revision 1.4  2003/10/09 13:44:30  mju
 * Remove rest of deprecated stuff.
 *
 * Revision 1.3  2003/10/08 22:03:21  mju
 * Remove unused deprecated stuff.
 *
 * Revision 1.2  2003/10/08 17:32:00  mju
 * Fix to compile.
 *
 * Revision 1.1  2003/10/08 16:40:01  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_MI32_MTIMER_H
#define  INC_MI32_MTIMER_H

#ifndef  INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif

#ifndef  INC_MI32_TEXTID_H
#include <mi32/textid.h>
#endif

class MISTRING;

#ifdef MISYSTEMDLL
   #define LIBEXPORT MI_DLLEXPORT
   #define CLASSLIBEXPORT MI_DLLCLASSEXPORT
#else
   #define LIBEXPORT MI_DLLIMPORT
   #define CLASSLIBEXPORT MI_DLLCLASSIMPORT
#endif


//=====================================================================================================================
//! Interval timer, used to time operations.
//! Timer is accurate to 100ns on Windows and 1ms on other platforms.
struct CLASSLIBEXPORT MTIMER {
   public:

      //! Default constructor
      MTIMER ();

      //! Destructor.
      ~MTIMER ();

      //! Clear timer.
      //! Also stops timer.
      void Clear ();

      // Get timer value as formatted string.
      void GetString (
         MISTRING& string
         ) const;

      //! Get the value of the timer in seconds.
      double GetValue (
         ) const;

      //! Determine if timer is currently 'on'.
      bool IsOn (
         ) const;

      //! Report "Time to ???: xxx xxx xxx".
      //!
      //! The ??? part is retrieved from the text resource file using the TEXTID provided.
      //! The rest of the message is built from text resource strings and the actual time.
      //!
      //! If TEXTID__None is specified then only the time is reported.
      void Report (
         MISTRING& string,
         TEXTID textid = TEXTID__None
         ) const;

   #if !defined(DEPRECATE_GROUPKEY) || defined(MISYSTEMDLL)
      //! Report "Time to ???: xxx xxx xxx".
      //! \deprecated Replaced by variant using TEXTID.
      //! The ??? part is retrieved from the text resource file using the TEXTID provided.
      //! The rest of the message is built from text resource strings and the actual time.
      //!
      //! If the group/key are NULL, it will just report the time
      DEPRECATED void Report (
         MISTRING& string,
         const char* group,
         const char* key
         ) const;
   #endif

      //! Report in "00:00" format
      void ReportShort (
         MISTRING& string,
         int places = 0    //!< number of decimal places in seconds (eg, 0:00.00)
         ) const;

      //! Start timer.
      void Start ();

      //! Set the value of the timer
      void Set (
         double seconds
         );

      //! Stop timer.
      //! Does not clear the timer.
      void Stop ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      double m_total;
      double m_StartTime;
      UINT8 m_TimerOn;
      UINT8 padding[7];

      CHECKSIZE(24)
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

//=====================================================================================================================
//    REMOVED - Begin

#ifndef GENERATING_DOXYGEN_OUTPUT
//! Removed items, still exported from DLL until sure all dependent EXEs rebuilt.
#ifdef MISYSTEMDLL

extern "C" {

//! Clear a timer.
LIBEXPORT void MtimerClear (
   MTIMER *timer
   );

//! Report timer value to formatted Unicode string.
//!
//! The message is generated using a two-step lookup process.  The specified group/key is used
//!   to get the "description" of what is being timed.  This is formatted (by default) in the form:
//!         Time to ???: XXX hours, XX minutes, XX seconds.
//!   where '???' is replaced by the message generated from the group/key.  If both group and key
//!   are NULL then only the time string with no prefix is generated.
LIBEXPORT void MtimerReportStr (
   const MTIMER *timer,                //!< Timer to report
   UNICODE* str,                       //!< String to hold message
   const char* group,                  //!< Message group
   const char* key                     //!< Message key
   );

//! Start a timer.
LIBEXPORT void MtimerStart (
   MTIMER *timer
   );

//! Stop a timer.
LIBEXPORT void MtimerStop (
   MTIMER *timer
   );

//! Get the value of a timer.
//!
//! @return The number of seconds that the timer has run.
LIBEXPORT double MtimerValue (
   MTIMER *timer
   );

//! Get current tick count.
//!
//! @return Clock "tick" of unknown starting time for use in interval timing.
LIBEXPORT UINT32 MtimerTickCount ();

}  // extern "C"

#endif
#endif // GENERATING_DOXYGEN_OUTPUT

//    REMOVED - End
//=====================================================================================================================

#undef LIBEXPORT
#undef CLASSLIBEXPORT

#endif   // INC_MI32_MTIMER_H

---