ActivityInterface.hpp

/***************************************************************************
  tag: Peter Soetens  Mon Jan 19 14:11:19 CET 2004  RunnableActivityInterface.hpp

                        ActivityInterface.hpp -  description
                           -------------------
    begin                : Mon January 19 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 ORO_ACTIVITY_INTERFACE_HPP
#define ORO_ACTIVITY_INTERFACE_HPP

#include "Time.hpp"
#include "os/ThreadInterface.hpp"
#include <boost/shared_ptr.hpp>

namespace RTT
{
    class RunnableInterface;

    class RTT_API ActivityInterface
    {
    protected:
        RunnableInterface* runner;

        void disableRun(RunnableInterface* caller) { if (caller == runner) runner = 0; }
    public:
        friend class RunnableInterface;

        typedef boost::shared_ptr<ActivityInterface> shared_ptr;

        ActivityInterface() : runner(0) {}

        ActivityInterface(RunnableInterface* run);

        virtual ~ActivityInterface();

        virtual bool run( RunnableInterface* r );

        virtual bool start() = 0;

        virtual bool stop() = 0;

        virtual bool isRunning() const = 0;

        virtual bool isActive() const = 0;

        virtual Seconds getPeriod() const = 0;

        virtual bool isPeriodic() const = 0;

        virtual bool execute() = 0;

        virtual bool trigger() = 0;

        virtual OS::ThreadInterface* thread() = 0;
    };

}

#endif