background_processing.h
Go to the documentation of this file.
00001 /*********************************************************************
00002  * Software License Agreement (BSD License)
00003  *
00004  *  Copyright (c) 2012, Willow Garage, Inc.
00005  *  All rights reserved.
00006  *
00007  *  Redistribution and use in source and binary forms, with or without
00008  *  modification, are permitted provided that the following conditions
00009  *  are met:
00010  *
00011  *   * Redistributions of source code must retain the above copyright
00012  *     notice, this list of conditions and the following disclaimer.
00013  *   * Redistributions in binary form must reproduce the above
00014  *     copyright notice, this list of conditions and the following
00015  *     disclaimer in the documentation and/or other materials provided
00016  *     with the distribution.
00017  *   * Neither the name of Willow Garage nor the names of its
00018  *     contributors may be used to endorse or promote products derived
00019  *     from this software without specific prior written permission.
00020  *
00021  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032  *  POSSIBILITY OF SUCH DAMAGE.
00033  *********************************************************************/
00034 
00035 /* Author: Ioan Sucan */
00036 
00037 #ifndef MOVEIT_BACKGROUND_PROCESSING_
00038 #define MOVEIT_BACKGROUND_PROCESSING_
00039 
00040 #include <deque>
00041 #include <string>
00042 #include <boost/thread.hpp>
00043 #include <boost/function.hpp>
00044 #include <boost/scoped_ptr.hpp>
00045 #include <boost/noncopyable.hpp>
00046 
00047 namespace moveit
00048 {
00052 namespace tools
00053 {
00057 class BackgroundProcessing : private boost::noncopyable
00058 {
00059 public:
00061   enum JobEvent
00062   {
00064     ADD,
00066     REMOVE,
00068     COMPLETE
00069   };
00070 
00073   typedef boost::function<void(JobEvent, const std::string&)> JobUpdateCallback;
00074 
00076   typedef boost::function<void()> JobCallback;
00077 
00079   BackgroundProcessing();
00080 
00082   ~BackgroundProcessing();
00083 
00085   void addJob(const JobCallback& job, const std::string& name);
00086 
00088   std::size_t getJobCount() const;
00089 
00091   void clear();
00092 
00094   void setJobUpdateEvent(const JobUpdateCallback& event);
00095 
00097   void clearJobUpdateEvent();
00098 
00099 private:
00100   boost::scoped_ptr<boost::thread> processing_thread_;
00101   bool run_processing_thread_;
00102 
00103   mutable boost::mutex action_lock_;
00104   boost::condition_variable new_action_condition_;
00105   std::deque<JobCallback> actions_;
00106   std::deque<std::string> action_names_;
00107 
00108   JobUpdateCallback queue_change_event_;
00109 
00110   bool processing_;
00111 
00112   void processingThread();
00113 };
00114 }
00115 }
00116 
00117 #endif


moveit_core
Author(s): Ioan Sucan , Sachin Chitta , Acorn Pooley
autogenerated on Wed Jan 17 2018 03:31:35