Orocos Real-Time Toolkit  2.8.3
Activity.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 22 11:59:07 CEST 2009 Activity.hpp
3 
4  Activity.hpp - description
5  -------------------
6  begin : Thu October 22 2009
7  copyright : (C) 2009 Peter Soetens
8  email : peter@thesourcworks.com
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 
39 #ifndef ORO_ACTIVITY_HPP
40 #define ORO_ACTIVITY_HPP
41 
42 #include "Time.hpp"
45 #include "os/Thread.hpp"
46 
47 namespace RTT
48 {
49 
64  : public base::ActivityInterface, public os::Thread
65  {
66  public:
75  Activity(base::RunnableInterface* r = 0, const std::string& name ="Activity" );
76 
87  Activity(int priority,
88  base::RunnableInterface* r = 0, const std::string& name ="Activity");
89 
102  Activity(int priority, Seconds period,
103  base::RunnableInterface* r = 0, const std::string& name ="Activity");
104 
117  Activity(int scheduler, int priority,
118  base::RunnableInterface* r = 0, const std::string& name ="Activity");
119 
134  Activity(int scheduler, int priority, Seconds period,
135  base::RunnableInterface* r = 0, const std::string& name ="Activity");
136 
153  Activity(int scheduler, int priority, Seconds period, unsigned cpu_affinity,
154  base::RunnableInterface* r = 0, const std::string& name ="Activity");
155 
159  virtual ~Activity();
160 
161  virtual bool start();
162 
163  virtual bool execute();
164 
165  virtual bool trigger();
166 
167  virtual bool stop();
168 
169  virtual bool isRunning() const;
170 
171  virtual bool isActive() const;
172 
173  virtual bool isPeriodic() const;
174 
175  virtual Seconds getPeriod() const;
176 
177  virtual bool setPeriod(Seconds period);
178 
179  virtual unsigned getCpuAffinity() const;
180 
181  virtual bool setCpuAffinity(unsigned cpu);
182 
183  virtual os::ThreadInterface* thread();
184 
188  virtual bool initialize();
189 
193  virtual void step();
194 
198  virtual void loop();
199 
203  virtual bool breakLoop();
204 
208  virtual void finalize();
209 
210  };
211 
212 }
213 
214 #endif
double Seconds
Seconds are stored as a double precision float.
Definition: Time.hpp:53
A Thread object executes user code in its own thread.
Definition: Thread.hpp:109
A class for running a certain piece of code in a thread.
#define RTT_API
Definition: rtt-config.h:97
A thread which is being run.
Interface to start/stop and query a Activity.
An Activity is an object that represents a thread.
Definition: Activity.hpp:63
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:51