low-can-binding/utils/timer.hpp

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 /// @brief return epoch in milliseconds
  21 ///
  22 /// @return long long int epoch in milliseconds
  23 typedef long long int (*time_function_t)();
  24
  25 long long int system_time_us();
  26 long long int system_time_ms();
  27 long long int system_time_s();
  28
  29
  30 /// @brief A frequency counting clock.
  31 /// Utility class allowing some time function.
  32 class frequency_clock_t
  33 {
  34 private:
  35         float unit_; ///< unit_ - multiplicator to make operation to be in the right unit (milli, micro, nano, etc)
  36         float frequency_; ///< the clock frequency in Hz.
  37         unsigned long last_tick_; ///< the last time (in milliseconds since startup) that the clock ticked.
  38         time_function_t time_function_; ///<  a function returning current time
  39
  40 public:
  41         frequency_clock_t();
  42         frequency_clock_t(float frequency);
  43         frequency_clock_t(float frequency, unsigned long last_tick, time_function_t time_function);
  44
  45         float get_frequency() const;
  46
  47         float frequency_to_period();
  48         bool started();
  49         time_function_t get_time_function();
  50         bool elapsed(bool stagger);
  51
  52         void tick();
  53 };