17.10.2013 - Adjusted for QNX, PIPeer release for Windows, Remote console
This commit is contained in:
111
pitimer.h
111
pitimer.h
@@ -1,3 +1,6 @@
|
||||
/*! \file pitimer.h
|
||||
* \brief Timer
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
Timer
|
||||
@@ -153,31 +156,38 @@ class PIP_EXPORT PITimer
|
||||
{
|
||||
PIOBJECT(PITimer)
|
||||
public:
|
||||
|
||||
//! \brief Constructs timer with execution function \b slot and common data \b data.
|
||||
PITimer(TimerEvent slot = 0, void * data = 0, bool threaded = true);
|
||||
PITimer(bool threaded);
|
||||
virtual ~PITimer();
|
||||
|
||||
|
||||
//! \brief Set custom data.
|
||||
void setData(void * data_) {data = data_;}
|
||||
|
||||
//! \brief Set timer execution function.
|
||||
void setSlot(TimerEvent slot) {ret_func = slot;}
|
||||
|
||||
//! \brief Returns current loop delay.
|
||||
double interval() const {return interval_;}
|
||||
#ifndef PIP_TIMER_RT
|
||||
|
||||
EVENT_HANDLER0(void, reset) {
|
||||
# ifdef WINDOWS
|
||||
EVENT_HANDLER0(void, reset) {t_st = GetCurrentTime();}
|
||||
t_st = GetCurrentTime();
|
||||
# elif defined(MAC_OS)
|
||||
EVENT_HANDLER0(void, reset) {clock_get_time(__pi_mac_clock, &t_st);}
|
||||
clock_get_time(__pi_mac_clock, &t_st);
|
||||
# else
|
||||
EVENT_HANDLER0(void, reset) {clock_gettime(0, &t_st);}
|
||||
clock_gettime(0, &t_st);
|
||||
# endif
|
||||
EVENT_HANDLER1(bool, start, int, timer_delay) {start(double(timer_delay)); return true;}
|
||||
}
|
||||
EVENT_HANDLER1(void, start, int, msecs) {start(double(msecs));}
|
||||
EVENT_HANDLER1(void, start, double, msecs);
|
||||
EVENT_HANDLER0(void, stop) {running_ = false;}
|
||||
EVENT_HANDLER2(void, deferredStart, double, interval_msecs, double, delay_msecs);
|
||||
EVENT_HANDLER2(void, deferredStart, double, interval_msecs, const PIDateTime &, start_datetime);
|
||||
#ifndef PIP_TIMER_RT
|
||||
EVENT_HANDLER0(void, stop) {running_ = false; PIThread::stop();}
|
||||
#else
|
||||
EVENT_HANDLER0(void, reset) {clock_gettime(0, &t_st);}
|
||||
EVENT_HANDLER1(void, start, double, msecs);
|
||||
EVENT_HANDLER2(void, deferredStart, double, interval_msecs, double, delay_msecs);
|
||||
EVENT_HANDLER2(void, deferredStart, double, interval_msecs, const PIDateTime &, start_datetime);
|
||||
EVENT_HANDLER0(void, stop);
|
||||
EVENT_HANDLER0(bool, waitForFinish) {return waitForFinish(-1);}
|
||||
EVENT_HANDLER1(bool, waitForFinish, int, timeout_msecs);
|
||||
@@ -186,9 +196,17 @@ public:
|
||||
EVENT_HANDLER0(void, lock) {mutex_.lock();}
|
||||
EVENT_HANDLER0(void, unlock) {mutex_.unlock();}
|
||||
#endif
|
||||
|
||||
//! \brief Add frequency delimiter \b delim with optional delimiter slot \b slot.
|
||||
void addDelimiter(int delim, TimerEvent slot = 0) {ret_funcs << TimerSlot(slot, delim);}
|
||||
|
||||
//! \brief Remove all frequency delimiters \b delim.
|
||||
void removeDelimiter(int delim) {for (int i = 0; i < ret_funcs.size_s(); ++i) if (ret_funcs[i].delim == delim) {ret_funcs.remove(i); i--;}}
|
||||
|
||||
//! \brief Remove all frequency delimiters with slot \b slot.
|
||||
void removeDelimiter(TimerEvent slot) {for (int i = 0; i < ret_funcs.size_s(); ++i) if (ret_funcs[i].slot == slot) {ret_funcs.remove(i); i--;}}
|
||||
|
||||
//! \brief Remove all frequency delimiters \b delim with slot \b slot.
|
||||
void removeDelimiter(int delim, TimerEvent slot) {for (int i = 0; i < ret_funcs.size_s(); ++i) if (ret_funcs[i].slot == slot && ret_funcs[i].delim == delim) {ret_funcs.remove(i); i--;}}
|
||||
void setDelimiterValue(int delim, int value) {for (int i = 0; i < ret_funcs.size_s(); ++i) if (ret_funcs[i].delim == delim) ret_funcs[i].tick = value;}
|
||||
void setDelimiterValue(TimerEvent slot, int value) {for (int i = 0; i < ret_funcs.size_s(); ++i) if (ret_funcs[i].slot == slot) ret_funcs[i].tick = value;}
|
||||
@@ -197,20 +215,40 @@ public:
|
||||
int delimiterValue(int delim, TimerEvent slot) {for (int i = 0; i < ret_funcs.size_s(); ++i) if (ret_funcs[i].slot == slot && ret_funcs[i].delim == delim) return ret_funcs[i].tick; return -1;}
|
||||
EVENT_HANDLER0(void, clearDelimiters) {ret_funcs.clear();}
|
||||
|
||||
|
||||
//! \brief Returns nanoseconds elapsed from last \a reset() execution or from timer creation.
|
||||
double elapsed_n(); // nanoseconds
|
||||
|
||||
//! \brief Returns microseconds elapsed from last \a reset() execution or from timer creation.
|
||||
double elapsed_u(); // microseconds
|
||||
|
||||
//! \brief Returns milliseconds elapsed from last \a reset() execution or from timer creation.
|
||||
double elapsed_m(); // milliseconds
|
||||
|
||||
//! \brief Returns seconds elapsed from last \a reset() execution or from timer creation.
|
||||
double elapsed_s(); // seconds
|
||||
|
||||
|
||||
double reset_time_n(); // nanoseconds
|
||||
double reset_time_u(); // microseconds
|
||||
double reset_time_m(); // milliseconds
|
||||
double reset_time_s(); // seconds
|
||||
|
||||
|
||||
//! \brief Returns time mark of last \a reset() execution or timer creation.
|
||||
PISystemTime reset_time();
|
||||
|
||||
|
||||
//! \brief Returns nanoseconds representation of current system time.
|
||||
static double elapsed_system_n(); // nanoseconds
|
||||
|
||||
//! \brief Returns microseconds representation of current system time.
|
||||
static double elapsed_system_u(); // microseconds
|
||||
|
||||
//! \brief Returns milliseconds representation of current system time.
|
||||
static double elapsed_system_m(); // milliseconds
|
||||
|
||||
//! \brief Returns seconds representation of current system time.
|
||||
static double elapsed_system_s(); // seconds
|
||||
|
||||
|
||||
@@ -244,7 +282,60 @@ public:
|
||||
|
||||
EVENT2(timeout, void * , data, int, delimiter)
|
||||
|
||||
//! \handlers
|
||||
//! \{
|
||||
|
||||
/** \fn void reset()
|
||||
* \brief Set internal time mark to current system time
|
||||
* \details This function used for set start time mark. Later
|
||||
* you can find out elapsed time from this time mark to any
|
||||
* moment of time with \a elapsed_s(), \a elapsed_m(),
|
||||
* \a elapsed_u() or \a elapsed_n() function.
|
||||
* \sa \a elapsed_s(), \a elapsed_m(), \a elapsed_u(), \a elapsed_n() */
|
||||
|
||||
/** \fn void start(int msecs)
|
||||
* \brief Start timer with \b msecs loop delay
|
||||
* \details Start execution of timer functions with frequency = 1 / msecs Hz. */
|
||||
|
||||
/** \fn void start(double msecs)
|
||||
* \brief Start timer with \b msecs loop delay
|
||||
* \details Start execution of timer functions with frequency = 1. / msecs Hz.
|
||||
* Instead of \a start(int msecs) function this variant allow start timer
|
||||
* with frequencies more than 1 kHz. */
|
||||
|
||||
//! \fn void stop()
|
||||
//! \brief Stop timer
|
||||
|
||||
/** \fn void deferredStart(double interval_msecs, double delay_msecs)
|
||||
* \brief Start timer with \b interval_msecs loop delay after \b delay_msecs delay.
|
||||
* \details Timer wait \b delay_msecs milliseconds and then normally starts with
|
||||
* \b interval_msecs loop delay.
|
||||
* \sa \a void start(double msecs), \a void deferredStart(double interval_msecs, const PIDateTime & start_datetime) */
|
||||
|
||||
/** \fn void deferredStart(double interval_msecs, const PIDateTime & start_datetime)
|
||||
* \brief Start timer with \b interval_msecs loop delay after \b start_datetime date and time.
|
||||
* \details Timer wait until \b start_datetime and then normally starts with
|
||||
* \b interval_msecs loop delay.
|
||||
* \sa \a void start(double msecs), \a void deferredStart(double interval_msecs, double delay_msecs) */
|
||||
|
||||
//! \fn void clearDelimiters()
|
||||
//! \brief Remove all frequency delimiters.
|
||||
|
||||
//! \}
|
||||
//! \events
|
||||
//! \{
|
||||
|
||||
/** \fn void timeout(void * data, int delimiter)
|
||||
* \brief Raise on timer tick
|
||||
* \details \b Data can be set with function \a setData(void * data) or from constructor.
|
||||
* \b Delimiter if frequency delimiter, 1 for main loop. */
|
||||
|
||||
|
||||
//! \}
|
||||
|
||||
protected:
|
||||
//! Virtual timer execution function, similar to "slot" or event \a void timeout(void * data, int delimiter).
|
||||
//! By default is empty.
|
||||
virtual void tick(void * data, int delimiter) {;}
|
||||
|
||||
private:
|
||||
|
||||
Reference in New Issue
Block a user