File: igstkRealTimeClock.h

package info (click to toggle)
igstk 4.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 38,980 kB
  • sloc: cpp: 86,267; xml: 96; makefile: 75; python: 38
file content (79 lines) | stat: -rw-r--r-- 2,133 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/*=========================================================================

  Program:   Image Guided Surgery Software Toolkit
  Module:    $RCSfile: igstkRealTimeClock.h,v $
  Language:  C++
  Date:      $Date: 2008-02-11 01:41:51 $
  Version:   $Revision: 1.5 $

  Copyright (c) ISC  Insight Software Consortium.  All rights reserved.
  See IGSTKCopyright.txt or http://www.igstk.org/copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/


#ifndef __igstkRealTimeClock_h
#define __igstkRealTimeClock_h

#include "itkIndent.h"

namespace igstk
{

/** \class RealTimeClock
 * \brief The RealTimeClock provides a timestamp from a real-time clock
 *
 * This class represents a real-time clock object 
 * and provides a timestamp in platform-independent format.
 *
 * \author Hee-Su Kim, Compute Science Dept. Kyungpook National University,
  Copyright (c) ISC  Insight Software Consortium.  All rights reserved.
 */
class RealTimeClock 
{
  
public:
  
  /** Define the type for the timestamp */
  typedef double        TimeStampType;

  /** Returns a timestamp in milliseconds   e.g. 52.341243 milliseconds */
  static TimeStampType  GetTimeStamp();

  /** Initialize internal variables on the Clock service.
   *  This method must be called at the begining of every
   *  IGSTK application. */
  static void Initialize();

  /** Print the object */
  static void Print(std::ostream& os, itk::Indent indent=0);

  /** Define the type for the frequency of the clock */
  typedef double        FrequencyType;

protected:

  /** constructor */
  RealTimeClock();

  /** destructor */
  virtual ~RealTimeClock();

  static void PrintSelf( std::ostream& os, itk::Indent indent );

private:
  
  static  FrequencyType    m_Frequency;
  static  TimeStampType    m_Difference;
  static  TimeStampType    m_Origin;

};

} // end of namespace itk


#endif  // __itkRealTimeClock_h