Main Page   Alphabetical List   Data Structures   File List   Data Fields   Globals   Examples  

timing.h

Go to the documentation of this file.
00001 /*! \file timing.h
00002     Header file for timing.c
00003  */
00004 
00005 #ifdef __cplusplus
00006 extern "C" {
00007 #endif
00008 
00009 #ifndef TIMING_HD
00010 
00011 #include <sys/time.h>
00012 
00013   int start_chrono();
00014   int stop_chrono();
00015   unsigned long int get_ms(); 
00016   int set_one_shot_timer(long sec, long micro_second);
00017   int cancel_one_shot_timer();
00018   int pause_one_shot_timer();
00019   int restart_one_shot_timer();
00020 
00021 
00022 /*! \brief Return value for the function set_one_shot_timer(). An error occured while setting the one shot timer.
00023  */
00024 #define SET_ONE_SHOT_TIMER_ERROR        -1
00025 
00026 /*! \brief Return value for the function set_one_shot_timer(). The one shot timer was successfully created.
00027  */
00028 #define SET_ONE_SHOT_TIMER_OK           -2
00029 
00030 /*! \brief Return value for the function cancel_one_shot_timer(). An error occured while canceling the one shot timer.
00031  */
00032 #define CANCEL_ONE_SHOT_TIMER_ERROR     -3
00033 
00034 /*! \brief Return value for the function cancel_one_shot_timer().  The one shot timer was successfully canceled.
00035  */
00036 #define CANCEL_ONE_SHOT_TIMER_OK        -4
00037 
00038 /*! \brief Return value for the function pause_one_shot_timer(). An error occured with the high precision timer.
00039  */
00040 #define PAUSE_ONE_SHOT_TIMER_ERROR      -5
00041 
00042 /*! \brief Return value for the function pause_one_shot_timer(). The one shot timer was successfully paused.
00043  */
00044 #define PAUSE_ONE_SHOT_TIMER_OK         -6
00045 
00046 /*! \brief Return value for the function restart_one_shot_timer(). An error occured with the high precision timer.
00047  */
00048 #define RESTART_ONE_SHOT_TIMER_ERROR    -7
00049 
00050 /*! \brief Return value for the function restart_one_shot_timer(). The one shot timer was successfully restarted.
00051  */
00052 #define RESTART_ONE_SHOT_TIMER_OK       -8
00053 
00054 
00055 #define TIMING_HD
00056 #endif
00057 
00058 #ifdef __cplusplus
00059 }
00060 #endif
00061 

Generated on Thu Apr 3 16:23:44 2003 for Common_C_libraries by doxygen1.3-rc1