|
|
Basic ClockP Parameters. More...
#include <ClockP.h>
Data Fields | |
| bool | startFlag |
| uint32_t | period |
| uintptr_t | arg |
Basic ClockP Parameters.
Structure that contains the parameters passed into ClockP_create or ClockP_construct when creating a ClockP instance. The ClockP_Params_init function should be used to initialize the fields to default values before the application sets the fields manually. The ClockP default parameters are noted in ClockP_Params_init.
The default startFlag is false, meaning the user will have to call ClockP_start(). If startFlag is true, the clock instance will be started automatically when it is created.
The default value of period is 0, indicating a one-shot clock object. A non-zero period indicates the clock function will be called periodically at the period rate (in system clock ticks), after the clock is initially started and set to expire with the 'timeout' argument.
| bool ClockP_Params::startFlag |
Start immediately after instance is created.
| uint32_t ClockP_Params::period |
Period of clock object.
| uintptr_t ClockP_Params::arg |
Argument passed to the clock function.