PeriodicThread.hpp

/***************************************************************************
  tag: Peter Soetens  Mon Jun 10 14:43:13 CEST 2002  PeriodicThread.hpp

                        PeriodicThread.hpp -  description
                           -------------------
    begin                : Mon June 10 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_PERIODIC_THREAD_HPP
#define ORO_PERIODIC_THREAD_HPP

// Our own package config headers.
#include "../rtt-config.h"
#include "fosi.h"

#include "RunnableInterface.hpp"
#include "ThreadInterface.hpp"

#include <string>

namespace RTT
{
    class RTT_API DigitalOutInterface;

    namespace OS {
    class RTT_API PeriodicThread
        : public OS::ThreadInterface
    {
        friend void* periodicThread( void* t );

    public:

        PeriodicThread(int priority,const std::string & name, double period, OS::RunnableInterface* r=0);

        PeriodicThread(int scheduler, int priority,const std::string & name, double period, OS::RunnableInterface* r=0);

        virtual ~PeriodicThread();

        virtual bool run( OS::RunnableInterface* r);

        virtual bool start();

        virtual bool stop();

        bool setPeriod( Seconds s );

        bool setPeriod( secs s, nsecs ns );

        void getPeriod( secs& s, nsecs& ns ) const;

        virtual Seconds getPeriod() const;

        virtual nsecs getPeriodNS() const;

        virtual bool isRunning() const;

        virtual bool isActive() const;

        virtual const char* getName() const;

        virtual RTOS_TASK * getTask(){return &rtos_task;};

        virtual bool setScheduler(int sched_type);
        virtual int getScheduler() const;

        bool setPeriod(  TIME_SPEC p );

        virtual bool setPriority(int priority);

        virtual int getPriority() const;

        virtual void yield();

        void setMaxOverrun( int m );
        int getMaxOverrun() const;

        void terminate();

        void emergencyStop();
     protected:

        virtual void continuousStepping(bool yes_no);
        virtual bool setToStop();

        virtual void step();

        virtual bool initialize();

        virtual void finalize();
     private:

        void setup(int _priority, const std::string& name);

        void configure();

        RTOS_TASK rtos_task;

        int msched_type;

        bool active, running;

        bool prepareForExit;

        bool wait_for_step;

        rt_sem_t sem;
        rt_sem_t confDone;
        OS::RunnableInterface* runComp;

        int maxOverRun;

        // Only used for passing on the period
        NANO_TIME period;

#ifdef OROPKG_OS_THREAD_SCOPE
    // Pointer to Threadscope device
        DigitalOutInterface * d;
#endif
    };

}}

#endif