roscpp: roscpp: timer_options.h Source 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_TIMER_OPTIONS_H
00029 #define ROSCPP_TIMER_OPTIONS_H
00030 
00031 #include "common.h"
00032 #include "ros/forwards.h"
00033 
00034 namespace ros
00035 {
00036 
00040 struct ROSCPP_DECL TimerOptions
00041 {
00042   TimerOptions()
00043     : period(0.1)
00044     , callback_queue(0)
00045     , oneshot(false)
00046     , autostart(true)
00047   { }
00048 
00049   /*
00050    * \brief Constructor
00051    * \param
00052    */
00053   TimerOptions(Duration _period, const TimerCallback& _callback, 
00054                CallbackQueueInterface* _queue, bool oneshot = false, bool autostart = true)
00055     : period(_period)
00056     , callback(_callback)
00057     , callback_queue(_queue)
00058     , oneshot(oneshot)
00059     , autostart(autostart)
00060   { }
00061 
00062   Duration period;                                                  
00063   TimerCallback callback;                                           
00064 
00065   CallbackQueueInterface* callback_queue;                           
00066 
00075   VoidConstPtr tracked_object;
00076 
00077   bool oneshot;
00078   bool autostart;
00079 };
00080 
00081 
00082 }
00083 
00084 #endif
00085