timer.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2009, Willow Garage, Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  * * Redistributions of source code must retain the above copyright notice,
7  * this list of conditions and the following disclaimer.
8  * * Redistributions in binary form must reproduce the above copyright
9  * notice, this list of conditions and the following disclaimer in the
10  * documentation and/or other materials provided with the distribution.
11  * * Neither the names of Willow Garage, Inc. nor the names of its
12  * contributors may be used to endorse or promote products derived from
13  * this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef ROSCPP_TIMER_H
29 #define ROSCPP_TIMER_H
30 
31 #include "common.h"
32 #include "forwards.h"
33 #include "timer_options.h"
34 
35 namespace ros
36 {
37 
46 class ROSCPP_DECL Timer
47 {
48 public:
49  Timer() {}
50  Timer(const Timer& rhs);
51  ~Timer();
52 
56  void start();
61  void stop();
62 
66  bool hasPending();
67 
72  void setPeriod(const Duration& period, bool reset=true);
73 
74  bool hasStarted() const { return impl_->hasStarted(); }
75  bool isValid() { return impl_ && impl_->isValid(); }
76  operator void*() { return isValid() ? (void*)1 : (void*)0; }
77 
78  bool operator<(const Timer& rhs)
79  {
80  return impl_ < rhs.impl_;
81  }
82 
83  bool operator==(const Timer& rhs)
84  {
85  return impl_ == rhs.impl_;
86  }
87 
88  bool operator!=(const Timer& rhs)
89  {
90  return impl_ != rhs.impl_;
91  }
92 
93 private:
94  Timer(const TimerOptions& ops);
95 
96  class Impl
97  {
98  public:
99  Impl();
100  ~Impl();
101 
102  bool hasStarted() const;
103  bool isValid();
104  bool hasPending();
105  void setPeriod(const Duration& period, bool reset=true);
106 
107  void start();
108  void stop();
109 
110  bool started_;
111  int32_t timer_handle_;
112 
118  bool oneshot_;
119  };
121  typedef boost::weak_ptr<Impl> ImplWPtr;
122 
123  ImplPtr impl_;
124 
125  friend class NodeHandle;
126 };
127 
128 }
129 
130 #endif
bool operator<(const Timer &rhs)
Definition: timer.h:78
ROSCPP_DECL void start()
Actually starts the internals of the node (spins up threads, starts the network polling and xmlrpc lo...
Definition: init.cpp:293
int32_t timer_handle_
Definition: timer.h:111
boost::function< void(const TimerEvent &)> TimerCallback
Definition: forwards.h:144
bool hasStarted() const
Definition: timer.h:74
VoidConstWPtr tracked_object_
Definition: timer.h:116
Abstract interface for a queue used to handle all callbacks within roscpp.
TimerCallback callback_
Definition: timer.h:114
boost::shared_ptr< Impl > ImplPtr
Definition: timer.h:120
bool operator!=(const Timer &rhs)
Definition: timer.h:88
Duration period_
Definition: timer.h:113
bool operator==(const Timer &rhs)
Definition: timer.h:83
Timer()
Definition: timer.h:49
boost::weak_ptr< void const > VoidConstWPtr
Definition: forwards.h:53
roscpp&#39;s interface for creating subscribers, publishers, etc.
Definition: node_handle.h:87
Encapsulates all options available for starting a timer.
Definition: timer_options.h:40
bool isValid()
Definition: timer.h:75
Manages a timer callback.
Definition: timer.h:46
CallbackQueueInterface * callback_queue_
Definition: timer.h:115
bool oneshot_
Definition: timer.h:118
bool started_
Definition: timer.h:110
boost::weak_ptr< Impl > ImplWPtr
Definition: timer.h:121
bool has_tracked_object_
Definition: timer.h:117
ImplPtr impl_
Definition: timer.h:123


roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim
autogenerated on Sun Aug 26 2018 03:03:33