ofTimer

class methods

ofTimer lets you run code periodically with the specified frequency. Use it on a class that extends ofThread.


class Scheduler: public ofThread {
public:
    Scheduler() {
        timer.setPeriodicEvent(1000000000); // this is 1 second in nanoseconds
        startThread();
    }

private:
    ofTimer timer;
    void threadedFunction() {
        while(isThreadRunning()) {
             timer.waitNext();
             // Do your thing here. It will run once per second.
        }
    }
}

The timer above will wake up at 1 second intervals no matter how long the rest of the task takes. If the last execution took more than 1 second, it'll wake up right away and execute the next. It uses the most accurate timing functions in every OS.

ofTimer()

ofTimer::ofTimer()

Documentation from code comments


Constructs the default ofTimer().

reset()

void ofTimer::reset()

Documentation from code comments


Reset the starting instant of the periodic event to now.

setPeriodicEvent(...)

void ofTimer::setPeriodicEvent(uint64_t nanoseconds)

Documentation from code comments


Sets the frequency in \p nanoseconds that events happen.

The timer will begin calculating the events beginning the moment the function is called.

Parameters:

nanoseconds The number of nanoseconds between events.

waitNext()

void ofTimer::waitNext()

Documentation from code comments


Sleep this thread until the next periodic event.

If you have any doubt about the usage of this module you can ask in the forum.

If you want to contribute better documentation or start documenting this section you can do so here

If you find anything wrong with this docs you can report any error by opening an issue