ros_timer.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD-3 License)
3  *
4  * Copyright (c) 2020 Jacob Willis.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * * Redistributions of source code must retain the above copyright notice, this
11  * list of conditions and the following disclaimer.
12  *
13  * * Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  *
17  * * Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived from
19  * this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
38 #ifndef ROSFLIGHT_ROS_TIMER_H
39 #define ROSFLIGHT_ROS_TIMER_H
40 
42 
43 #include <ros/ros.h>
44 
45 #include <memory>
46 #include <vector>
47 
48 namespace rosflight
49 {
51 {
52 public:
53  inline ROSTimer(std::chrono::nanoseconds period,
54  std::function<void()> callback,
55  const bool oneshot,
56  const bool autostart) :
57  callback_(callback)
58  {
59  ros::NodeHandle nh;
60  ros_timer_ = nh.createTimer(ros::Duration(0, period.count()), &ROSTimer::callback_ros_, this, oneshot, autostart);
61  }
62 
63  inline void start() { ros_timer_.start(); }
64 
65  inline void stop() { ros_timer_.stop(); }
66 
67  inline void callback_ros_(const ros::TimerEvent& event) const { callback_(); };
68 
69 private:
71  std::function<void()> callback_;
72 };
73 
75 {
76 public:
77  inline std::shared_ptr<mavrosflight::TimerInterface> create_timer(std::chrono::nanoseconds period,
78  std::function<void()> callback,
79  const bool oneshot = false,
80  const bool autostart = true)
81  {
82  return std::make_shared<ROSTimer>(period, callback, oneshot, autostart);
83  }
84 };
85 
86 } // namespace rosflight
87 #endif /* ROSFLIGHT_ROS_TIMER_H */
ros::Timer ros_timer_
Definition: ros_timer.h:67
std::function< void()> callback_
Definition: ros_timer.h:71
std::shared_ptr< mavrosflight::TimerInterface > create_timer(std::chrono::nanoseconds period, std::function< void()> callback, const bool oneshot=false, const bool autostart=true)
Definition: ros_timer.h:77
ROSTimer(std::chrono::nanoseconds period, std::function< void()> callback, const bool oneshot, const bool autostart)
Definition: ros_timer.h:53
void stop()
void start()
Abstracts basic timer functionality.
Timer createTimer(Rate r, Handler h, Obj o, bool oneshot=false, bool autostart=true) const
Provide an interface for creating timers.
void callback_ros_(const ros::TimerEvent &event) const
Definition: ros_timer.h:67


rosflight
Author(s): Daniel Koch , James Jackson
autogenerated on Thu Apr 15 2021 05:09:26