ActivityInterface.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Mon Jan 19 14:11:19 CET 2004 RunnableActivityInterface.hpp
3 
4  ActivityInterface.hpp - description
5  -------------------
6  begin : Mon January 19 2004
7  copyright : (C) 2004 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 ORO_ACTIVITY_INTERFACE_HPP
39 #define ORO_ACTIVITY_INTERFACE_HPP
40 
41 #include "../Time.hpp"
42 #include "../os/ThreadInterface.hpp"
43 #include <boost/shared_ptr.hpp>
44 #include "rtt-base-fwd.hpp"
45 
46 namespace RTT
47 { namespace base {
48 
62  class RTT_API ActivityInterface
63  {
64  protected:
66 
73  void disableRun(RunnableInterface* caller) { if (caller == runner) runner = 0; }
74  public:
75  friend class RunnableInterface;
76 
77  typedef boost::shared_ptr<ActivityInterface> shared_ptr;
78 
79  ActivityInterface() : runner(0) {}
80 
82 
83  virtual ~ActivityInterface();
84 
92  virtual bool run( RunnableInterface* r );
93 
104  virtual bool start() = 0;
105 
115  virtual bool stop() = 0;
116 
128  virtual bool isRunning() const = 0;
129 
138  virtual bool isActive() const = 0;
139 
145  virtual Seconds getPeriod() const = 0;
146 
153  virtual bool isPeriodic() const = 0;
154 
162  virtual bool setPeriod(Seconds s) = 0;
163 
164 
170  virtual unsigned getCpuAffinity() const = 0;
171 
176  virtual bool setCpuAffinity(unsigned cpu) = 0;
177 
193  virtual bool execute() = 0;
194 
216  virtual bool trigger() = 0;
217 
224  virtual bool timeout() = 0;
225 
230  virtual os::ThreadInterface* thread() = 0;
231 
235  virtual RunnableInterface* getRunner() const;
236  };
237 
238 }}
239 
240 #endif
double Seconds
Definition: os/Time.hpp:53
A class for running a certain piece of code in a thread.
boost::shared_ptr< ActivityInterface > shared_ptr
static RTT_UNUSED bool setCpuAffinity(ThreadInterface *thread, const std::bitset< 16 > &cpu_affinity)
Interface to start/stop and query a Activity.
static std::bitset< 16 > getCpuAffinity(ThreadInterface *thread)
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:53
void disableRun(RunnableInterface *caller)
static bool trigger(TaskContext *tc)


rtt
Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:30