ThreadInterface.hpp

/***************************************************************************
  tag: Peter Soetens  Sat May 21 20:15:51 CEST 2005  ThreadInterface.hpp

                        ThreadInterface.hpp -  description
                           -------------------
    begin                : Sat May 21 2005
    copyright            : (C) 2005 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 OS_THREAD_INTERFACE_HPP
#define OS_THREAD_INTERFACE_HPP

#include "fosi.h"
#include "threads.hpp"
#include "Time.hpp"
#include "../rtt-config.h"

namespace RTT
{
    namespace os
    {
        class RTT_API ThreadInterface
        {
        public:
            ThreadInterface();
            virtual ~ThreadInterface();

            virtual bool start() = 0;

            virtual bool stop() = 0;

            virtual Seconds getPeriod() const = 0;

            virtual bool setPeriod(Seconds new_period) = 0;

            virtual nsecs getPeriodNS() const = 0;

            virtual bool isRunning() const = 0;

            virtual bool isActive() const = 0;

            virtual const char* getName() const = 0;

            virtual RTOS_TASK * getTask() = 0;

            virtual const RTOS_TASK * getTask() const = 0;

            virtual bool setScheduler(int sched_type) = 0;

            virtual int getScheduler() const = 0;

            virtual bool setPriority(int priority) = 0;

            virtual int getPriority() const = 0;

            virtual unsigned int getPid() const = 0;

            virtual void setMaxOverrun(int m) = 0;

            virtual int getMaxOverrun() const = 0;

            virtual void setWaitPeriodPolicy(int p) = 0;

            virtual void yield() = 0;

            unsigned int threadNumber() const
            {
                return threadnb;
            }

            bool isSelf() const;
        protected:
            int threadnb;
        };
    }
}

#endif