Orocos Real-Time Toolkit  2.9.0
ActionInterface.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 10 16:19:04 CEST 2002 ActionInterface.hpp
3 
4  ActionInterface.hpp - description
5  -------------------
6  begin : Thu October 10 2002
7  copyright : (C) 2002 Peter Soetens
8  email : peter.soetens@mech.kuleuven.ac.be
9 
10  ***************************************************************************
11  * This library is free software; you can redistribute it and/or *
12  * modify it under the terms of the GNU General Public *
13  * License as published by the Free Software Foundation; *
14  * version 2 of the License. *
15  * *
16  * As a special exception, you may use this file as part of a free *
17  * software library without restriction. Specifically, if other files *
18  * instantiate templates or use macros or inline functions from this *
19  * file, or you compile this file and link it with other files to *
20  * produce an executable, this file does not by itself cause the *
21  * resulting executable to be covered by the GNU General Public *
22  * License. This exception does not however invalidate any other *
23  * reasons why the executable file might be covered by the GNU General *
24  * Public License. *
25  * *
26  * This library is distributed in the hope that it will be useful, *
27  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
29  * Lesser General Public License for more details. *
30  * *
31  * You should have received a copy of the GNU General Public *
32  * License along with this library; if not, write to the Free Software *
33  * Foundation, Inc., 59 Temple Place, *
34  * Suite 330, Boston, MA 02111-1307 USA *
35  * *
36  ***************************************************************************/
37 
38 #ifndef ACTIONINTERFACE_HPP
39 #define ACTIONINTERFACE_HPP
40 
41 #include <map>
42 #include <boost/shared_ptr.hpp>
43 #include "../rtt-config.h"
44 #include "rtt-base-fwd.hpp"
45 
46 #ifdef ORO_PRAGMA_INTERFACE
47 #pragma interface
48 #endif
49 
50 namespace RTT { namespace base {
51 
72  {
73  public:
78  typedef boost::shared_ptr<ActionInterface> shared_ptr;
79 
80  virtual ~ActionInterface();
81 
86  virtual bool execute() = 0;
87 
91  virtual void reset();
92 
100  virtual bool valid() const;
101 
106  virtual void readArguments() = 0;
107 
111  virtual ActionInterface* clone() const = 0;
112 
130  virtual ActionInterface* copy( std::map<const DataSourceBase*, DataSourceBase*>& alreadyCloned ) const;
131  };
132 
133 }}
134 
135 #endif // ACTIONINTERFACE_HPP
#define RTT_API
Definition: rtt-config.h:97
Based on the software pattern &#39;command&#39;, this interface allows execution of action objects...
boost::shared_ptr< ActionInterface > shared_ptr
Use this type for shared pointer storage of an ActionInterface object.
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52