NonPeriodicActivity.hpp

00001 /***************************************************************************
00002   tag: Peter Soetens  Tue Apr 5 16:53:25 CEST 2005  NonPeriodicActivity.hpp
00003 
00004                         NonPeriodicActivity.hpp -  description
00005                            -------------------
00006     begin                : Tue April 05 2005
00007     copyright            : (C) 2005 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 
00039 #ifndef TASK_NON_PERIODIC_HPP
00040 #define TASK_NON_PERIODIC_HPP
00041 
00042 #include "ActivityInterface.hpp"
00043 #include "RunnableInterface.hpp"
00044 #include "os/SingleThread.hpp"
00045 
00046 #ifdef ORO_PRAGMA_INTERFACE
00047 #pragma interface
00048 #endif
00049 
00050 namespace RTT
00051 {
00052 
00060     class RTT_API NonPeriodicActivity
00061         :public ActivityInterface,
00062          private OS::SingleThread
00063     {
00064     public:
00065         using OS::SingleThread::run;
00066         using ActivityInterface::run;
00067 
00076         NonPeriodicActivity(int priority, RunnableInterface* _r = 0 );
00077 
00087         NonPeriodicActivity(int scheduler, int priority, RunnableInterface* _r = 0 );
00088 
00096         NonPeriodicActivity(int priority, const std::string& name, RunnableInterface* _r = 0 );
00097 
00098         virtual ~NonPeriodicActivity();
00099 
00105         bool run( int ) { RunnableInterface* d(0); return ActivityInterface::run(d); }
00106 
00107         virtual Seconds getPeriod() const ;
00108 
00109         virtual ThreadInterface* thread();
00110 
00111         virtual bool initialize();
00112 
00113         virtual void loop();
00114 
00115         virtual bool breakLoop();
00116 
00117         virtual void finalize();
00118 
00119         virtual bool isPeriodic() const;
00120 
00121         virtual bool start();
00122 
00123         virtual bool execute();
00124 
00125         virtual bool trigger();
00126 
00127         virtual bool stop();
00128 
00129         virtual bool isRunning() const;
00130 
00131         virtual bool isActive() const;
00132 
00133 };
00134 
00135 }
00136 
00137 
00138 #endif
Generated on Thu Dec 23 13:22:38 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3