mbed library sources. Supersedes mbed-src.
Dependents: Hobbyking_Cheetah_Compact Hobbyking_Cheetah_Compact_DRV8323_14bit Hobbyking_Cheetah_Compact_DRV8323_V51_201907 HKC_MiniCheetah ... more
Fork of mbed-dev by
Diff: drivers/Ticker.h
- Revision:
- 167:e84263d55307
- Parent:
- 160:d5399cc887bb
- Child:
- 168:9672193075cf
--- a/drivers/Ticker.h Thu Jun 08 15:02:37 2017 +0100 +++ b/drivers/Ticker.h Wed Jun 21 17:46:44 2017 +0100 @@ -22,13 +22,12 @@ namespace mbed { /** \addtogroup drivers */ -/** @{*/ /** A Ticker is used to call a function at a recurring interval * * You can use as many seperate Ticker objects as you require. * - * @Note Synchronization level: Interrupt safe + * @note Synchronization level: Interrupt safe * * Example: * @code @@ -58,6 +57,7 @@ * } * } * @endcode + * @ingroup drivers */ class Ticker : public TimerEvent { @@ -97,18 +97,18 @@ /** Attach a function to be called by the Ticker, specifiying the interval in micro-seconds * - * @param fptr pointer to the function to be called + * @param func pointer to the function to be called * @param t the time between calls in micro-seconds */ - void attach_us(Callback<void()> func, timestamp_t t) { + void attach_us(Callback<void()> func, us_timestamp_t t) { _function = func; setup(t); } /** Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds * - * @param tptr pointer to the object to call the member function on - * @param mptr pointer to the member function to be called + * @param obj pointer to the object to call the member function on + * @param method pointer to the member function to be called * @param t the time between calls in micro-seconds * @deprecated * The attach_us function does not support cv-qualifiers. Replaced by @@ -118,7 +118,7 @@ MBED_DEPRECATED_SINCE("mbed-os-5.1", "The attach_us function does not support cv-qualifiers. Replaced by " "attach_us(callback(obj, method), t).") - void attach_us(T *obj, M method, timestamp_t t) { + void attach_us(T *obj, M method, us_timestamp_t t) { attach_us(Callback<void()>(obj, method), t); } @@ -131,16 +131,14 @@ void detach(); protected: - void setup(timestamp_t t); + void setup(us_timestamp_t t); virtual void handler(); protected: - timestamp_t _delay; /**< Time delay (in microseconds) for re-setting the multi-shot callback. */ + us_timestamp_t _delay; /**< Time delay (in microseconds) for re-setting the multi-shot callback. */ Callback<void()> _function; /**< Callback. */ }; } // namespace mbed #endif - -/** @}*/