wall_timer.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (C) 2009, Willow Garage, Inc.
00003  *
00004  * Redistribution and use in source and binary forms, with or without
00005  * modification, are permitted provided that the following conditions are met:
00006  *   * Redistributions of source code must retain the above copyright notice,
00007  *     this list of conditions and the following disclaimer.
00008  *   * Redistributions in binary form must reproduce the above copyright
00009  *     notice, this list of conditions and the following disclaimer in the
00010  *     documentation and/or other materials provided with the distribution.
00011  *   * Neither the names of Stanford University or Willow Garage, Inc. nor the names of its
00012  *     contributors may be used to endorse or promote products derived from
00013  *     this software without specific prior written permission.
00014  *
00015  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00016  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00017  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00018  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00019  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00020  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00021  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00024  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00025  * POSSIBILITY OF SUCH DAMAGE.
00026  */
00027 
00028 #ifndef ROSCPP_WALL_TIMER_H
00029 #define ROSCPP_WALL_TIMER_H
00030 
00031 #include "common.h"
00032 #include "forwards.h"
00033 #include "wall_timer_options.h"
00034 
00035 namespace ros
00036 {
00037 
00046 class ROSCPP_DECL WallTimer
00047 {
00048 public:
00049   WallTimer() {}
00050   WallTimer(const WallTimer& rhs);
00051   ~WallTimer();
00052 
00056   void start();
00061   void stop();
00062 
00066   bool hasPending();
00067 
00072   void setPeriod(const WallDuration& period, bool reset=true);
00073 
00074   bool isValid() { return impl_ && impl_->isValid(); }
00075   operator void*() { return isValid() ? (void*)1 : (void*)0; }
00076 
00077   bool operator<(const WallTimer& rhs)
00078   {
00079     return impl_ < rhs.impl_;
00080   }
00081 
00082   bool operator==(const WallTimer& rhs)
00083   {
00084     return impl_ == rhs.impl_;
00085   }
00086 
00087   bool operator!=(const WallTimer& rhs)
00088   {
00089     return impl_ != rhs.impl_;
00090   }
00091 
00092 private:
00093   WallTimer(const WallTimerOptions& ops);
00094 
00095   class Impl
00096   {
00097   public:
00098     Impl();
00099     ~Impl();
00100 
00101     bool isValid();
00102     bool hasPending();
00103     void setPeriod(const WallDuration& period, bool reset=true);
00104 
00105     void start();
00106     void stop();
00107 
00108     bool started_;
00109     int32_t timer_handle_;
00110 
00111     WallDuration period_;
00112     WallTimerCallback callback_;
00113     CallbackQueueInterface* callback_queue_;
00114     VoidConstWPtr tracked_object_;
00115     bool has_tracked_object_;
00116     bool oneshot_;
00117   };
00118   typedef boost::shared_ptr<Impl> ImplPtr;
00119   typedef boost::weak_ptr<Impl> ImplWPtr;
00120 
00121   ImplPtr impl_;
00122 
00123   friend class NodeHandle;
00124 };
00125 
00126 }
00127 
00128 #endif


roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim
autogenerated on Tue Mar 7 2017 04:01:04