Orocos Real-Time Toolkit  2.6.0
ActionInterface.hpp
00001 /***************************************************************************
00002   tag: Peter Soetens  Thu Oct 10 16:19:04 CEST 2002  ActionInterface.hpp
00003 
00004                         ActionInterface.hpp -  description
00005                            -------------------
00006     begin                : Thu October 10 2002
00007     copyright            : (C) 2002 Peter Soetens
00008     email                : peter.soetens@mech.kuleuven.ac.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 #ifndef ACTIONINTERFACE_HPP
00039 #define ACTIONINTERFACE_HPP
00040 
00041 #include <map>
00042 #include <boost/shared_ptr.hpp>
00043 #include "../rtt-config.h"
00044 #include "rtt-base-fwd.hpp"
00045 
00046 #ifdef ORO_PRAGMA_INTERFACE
00047 #pragma interface
00048 #endif
00049 
00050 namespace RTT { namespace base {
00051 
00071     class RTT_API ActionInterface
00072     {
00073     public:
00078         typedef boost::shared_ptr<ActionInterface> shared_ptr;
00079 
00080         virtual ~ActionInterface();
00081 
00086         virtual bool execute() = 0;
00087 
00091         virtual void reset();
00092 
00100         virtual bool valid() const;
00101 
00106         virtual void readArguments() = 0;
00107 
00111         virtual ActionInterface* clone() const = 0;
00112 
00130         virtual ActionInterface* copy( std::map<const DataSourceBase*, DataSourceBase*>& alreadyCloned ) const;
00131     };
00132 
00133 }}
00134 
00135 #endif // ACTIONINTERFACE_HPP