CommandProcessor.hpp

00001 /***************************************************************************
00002   tag: Peter Soetens  Wed Jan 18 14:11:40 CET 2006  CommandProcessor.hpp
00003 
00004                         CommandProcessor.hpp -  description
00005                            -------------------
00006     begin                : Wed January 18 2006
00007     copyright            : (C) 2006 Peter Soetens
00008     email                : peter.soetens@mech.kuleuven.be
00009 
00010  ***************************************************************************
00011  *   This library is free software; you can redistribute it and/or         *
00012  *   modify it under the terms of the GNU General Public                   *
00013  *   License as published by the Free Software Foundation;                 *
00014  *   version 2 of the License.                                             *
00015  *                                                                         *
00016  *   As a special exception, you may use this file as part of a free       *
00017  *   software library without restriction.  Specifically, if other files   *
00018  *   instantiate templates or use macros or inline functions from this     *
00019  *   file, or you compile this file and link it with other files to        *
00020  *   produce an executable, this file does not by itself cause the         *
00021  *   resulting executable to be covered by the GNU General Public          *
00022  *   License.  This exception does not however invalidate any other        *
00023  *   reasons why the executable file might be covered by the GNU General   *
00024  *   Public License.                                                       *
00025  *                                                                         *
00026  *   This library is distributed in the hope that it will be useful,       *
00027  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00028  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00029  *   Lesser General Public License for more details.                       *
00030  *                                                                         *
00031  *   You should have received a copy of the GNU General Public             *
00032  *   License along with this library; if not, write to the Free Software   *
00033  *   Foundation, Inc., 59 Temple Place,                                    *
00034  *   Suite 330, Boston, MA  02111-1307  USA                                *
00035  *                                                                         *
00036  ***************************************************************************/
00037 
00038 
00039 
00040 #ifndef ORO_COMMAND_PROCESSOR_HPP
00041 #define ORO_COMMAND_PROCESSOR_HPP
00042 
00043 #include "RunnableInterface.hpp"
00044 #include "CommandInterface.hpp"
00045 #include "BufferPolicy.hpp"
00046 
00047 #include <string>
00048 #include <vector>
00049 #include <boost/shared_ptr.hpp>
00050 
00051 namespace RTT
00052 {
00053     template< class T, class RP, class WP>
00054     class Queue;
00055 }
00056 
00057 namespace RTT
00058 {
00075     class RTT_API CommandProcessor
00076         : public RunnableInterface
00077     {
00078     public:
00083         CommandProcessor(int queue_size = ORONUM_EXECUTION_PROC_QUEUE_SIZE);
00084 
00085         virtual ~CommandProcessor();
00086 
00087         virtual bool initialize();
00088         virtual void step();
00089         virtual void finalize();
00090         virtual bool hasWork();
00091 
00110         virtual int process(CommandInterface* c);
00111 
00115         virtual bool isProcessed( int id ) const;
00116 
00121         void acceptCommands( bool true_false) { accept=true_false; }
00122 
00123     protected:
00124 
00125         Queue<CommandInterface*,NonBlockingPolicy,NonBlockingPolicy>* a_queue;
00126 
00130         int coms_processed;
00131 
00132         bool accept;
00133     };
00134 
00135 }
00136 
00137 #endif
Generated on Thu Dec 23 13:22:36 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3