step_trigger.hpp

Go to the documentation of this file.

#ifndef STEP_TRIGGER_HPP
#define STEP_TRIGGER_HPP

class StepTrigger{
    bool initialized;
    int period;     
    int first_step; 
    int last_step;  

    public:

    StepTrigger()
      : initialized(false)   {}

    StepTrigger(int period, int first_step_in=-1, int last_step_in=-1)
      : initialized(true),
        period(period),
        // If no value is provided for the optional first_step_in argument, then the first step is the period
        // i.e. if period is 2, then the first call is on step 2
        first_step(first_step_in==-1 ? period : first_step_in),
        last_step(last_step_in) {}

    /* Returns whether or not the action is triggered this step
     * */
    bool is_triggered(int step) const{
        int steps_since_first = step - first_step;
        return (initialized &&
                (step>=first_step && steps_since_first%period==0) &&
                (last_step==-1 || step<=last_step)
                );
    }

    /* Returns whether or not we have passed the first trigger yet
     * */
    bool has_been_triggered(int step) const{
        return (initialized && step>=first_step);
    }

    /* Returns period
     * */
    int get_period() const{
        return period;
    }

    int trigger_count(int step) const{
        if (initialized){
            // C++ rounds down by default
            return ( (step-first_step)/period );
        } else {
            return (0);
        }
    }
};

#endif