SimulationThread.hpp

/***************************************************************************
  tag: Peter Soetens  Tue Dec 21 22:43:07 CET 2004  SimulationThread.hpp

                        SimulationThread.hpp -  description
                           -------------------
    begin                : Tue December 21 2004
    copyright            : (C) 2004 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 SIMULATIONTHREAD_HPP
#define SIMULATIONTHREAD_HPP

#include "TimerThread.hpp"


namespace RTT
{

    class SimulationActivity;
    class SimulationThread;
    class TimeService;
    typedef boost::shared_ptr<SimulationThread> SimulationThreadPtr;

    class RTT_API SimulationThread
        : public TimerThread
    {
    public:
        static SimulationThreadPtr Instance(double period = 0.001);

        static bool Release();

        virtual ~SimulationThread();

        virtual bool start();

        virtual bool isRunning() const;

        virtual bool start(unsigned int maxsteps);

        using OS::PeriodicThread::run;
        virtual bool run(unsigned int maxsteps);

    protected:
        bool initialize();
        void step();
        void finalize();

        SimulationThread(double period);

    private:

        static SimulationThreadPtr _instance;

        TimeService* beat;

        unsigned int maxsteps_, cursteps;

        bool sim_running;
    };
} // namespace RTT

#endif