TimerThread.hpp

/***************************************************************************
 tag: Peter Soetens  Wed Apr 17 16:01:36 CEST 2002  TimerThread.h

                       TimerThread.h -  description
                          -------------------
   begin                : Wed April 17 2002
   copyright            : (C) 2002 Peter Soetens
   email                : peter.soetens@mech.kuleuven.ac.be

 ***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU General Public                   *
 *   License as published by the Free Software Foundation;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef ORO_TIMERTHREAD_HPP
#define ORO_TIMERTHREAD_HPP


#include "os/PeriodicThread.hpp"

#include "os/Mutex.hpp"

#include <list>
#include <vector>
#include <string>
#include <boost/shared_ptr.hpp>
#include <boost/weak_ptr.hpp>

namespace RTT
{
    class PeriodicActivity;
    class TimerThread;

    typedef boost::shared_ptr<TimerThread> TimerThreadPtr;

    class RTT_API TimerThread
        : public OS::PeriodicThread
    {
        typedef std::vector<PeriodicActivity*> ActivityList ;
        ActivityList tasks;
        bool cleanup;
    public:
        static const unsigned int MAX_ACTIVITIES = 64;
        TimerThread(int priority, const std::string& name, double periodicity);

        TimerThread(int scheduler, int priority, const std::string& name, double periodicity);

        virtual ~TimerThread();

        bool addActivity( PeriodicActivity* t );

        bool removeActivity( PeriodicActivity* t );

        static TimerThreadPtr Instance(int priority, double periodicity);
        static TimerThreadPtr Instance(int scheduler, int priority, double periodicity);
    protected:
        virtual bool initialize();
        virtual void step();
        virtual void finalize();
        void reorderList();
        mutable OS::MutexRecursive mutex;

        typedef std::vector< boost::weak_ptr<TimerThread> > TimerThreadList;

        static TimerThreadList TimerThreads;
    };
} // namespace RTT

#endif