summaryrefslogtreecommitdiff
path: root/tests/Xt_Stopwatch/timer.h
diff options
context:
space:
mode:
Diffstat (limited to 'tests/Xt_Stopwatch/timer.h')
-rw-r--r--tests/Xt_Stopwatch/timer.h51
1 files changed, 24 insertions, 27 deletions
diff --git a/tests/Xt_Stopwatch/timer.h b/tests/Xt_Stopwatch/timer.h
index 1708bbc8428..e96d6c614f8 100644
--- a/tests/Xt_Stopwatch/timer.h
+++ b/tests/Xt_Stopwatch/timer.h
@@ -1,17 +1,14 @@
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/tests/Xt_Stopwatch
-//
-// = FILENAME
-// timer.h
-//
-// = AUTHOR
-// Bala <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file timer.h
+ *
+ * $Id$
+ *
+ * @author Bala <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TIMER_H
#define TIMER_H
@@ -26,49 +23,49 @@ class Timer_imp
{
public:
+ /// Constructor
Timer_imp (XtAppContext &,
CORBA::Long,
Stopwatch_display *);
- // Constructor
+ /// Destructor
virtual ~Timer_imp ();
- // Destructor
+ /// Resets, and starts the clock ticking
void start (void);
- // Resets, and starts the clock ticking
+ /// Stops the clock
void stop (void);
- // Stops the clock
+ /// Returns time since timer started
CORBA::Float elapsed_time (void);
- // Returns time since timer started
private:
+ /// Static member function used for TimeOut callback.
static void tick_callback (XtPointer,
XtIntervalId *);
- // Static member function used for TimeOut callback.
+ /// Called every interval_ milliseconds
void tick (void);
- // Called every interval_ milliseconds
+ /// Called at each clock tick...
virtual void report_time (CORBA::Float);
- // Called at each clock tick...
+ /// A copy of the stopwatch object
Stopwatch_display *stopwatch_;
- // A copy of the stopwatch object
+ /// Current number of ticks
CORBA::Long counter_;
- // Current number of ticks
+ /// Time in milliseconds between updates
CORBA::Long interval_;
- // Time in milliseconds between updates
+ /// Identifier of current TimeOut
XtIntervalId id_;
- // Identifier of current TimeOut
+ /// Required by Xt functions
XtAppContext app_;
- // Required by Xt functions
};