FileDescriptorSimulationActivity.hpp

Go to the documentation of this file.

/***************************************************************************

 ***************************************************************************
 *   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 FILEDESCRIPTORSIMULATION_ACTIVITY_HPP
#define FILEDESCRIPTORSIMULATION_ACTIVITY_HPP

#include "../base/ActivityInterface.hpp"
#include "../base/RunnableInterface.hpp"
#include "../extras/FileDescriptorActivityInterface.hpp"

namespace RTT { namespace extras {

    class RTT_API FileDescriptorSimulationActivity : public extras::FileDescriptorActivityInterface,
                                                     public base::ActivityInterface
    {
    public:
        // priority and name are ignored
        FileDescriptorSimulationActivity(int priority,
                                         base::RunnableInterface* _r = 0,
                                         const std::string& name ="FileDescriptorSimulationActivity" );

        // scheduler, priority, and name, are ignored
        FileDescriptorSimulationActivity(int scheduler,
                                         int priority,
                                         base::RunnableInterface* _r = 0,
                                         const std::string& name ="FileDescriptorSimulationActivity" );

        // scheduler, priority, and name, are ignored
        FileDescriptorSimulationActivity(int scheduler,
                                         int priority,
                                         Seconds period,
                                         base::RunnableInterface* _r = 0,
                                         const std::string& name ="FileDescriptorSimulationActivity" );

        // scheduler, priority, cpu_affinity, and name, are ignored
        FileDescriptorSimulationActivity(int scheduler,
                                         int priority,
                                         Seconds period,
                                         unsigned cpu_affinity,
                                         base::RunnableInterface* _r = 0,
                                         const std::string& name ="FileDescriptorSimulationActivity" );

        virtual ~FileDescriptorSimulationActivity();

        /**********************************************************************
         * FDAInterface functions
         **********************************************************************/

        void watch(int fd);

        void unwatch(int fd);

        void clearAllWatches();

        bool isWatched(int fd) const;

        bool isUpdated(int fd) const;

        bool hasTimeout() const;

        bool hasError() const;

        void setTimeout(int timeout);

        void setTimeout_us(int timeout_us);

        int getTimeout() const;

        int getTimeout_us() const;

        /**********************************************************************
         * ActivityInterface functions
         **********************************************************************/

        virtual bool start();
        virtual bool stop();
        virtual bool isRunning() const;
        virtual bool isActive() const;
        virtual Seconds getPeriod() const;
        virtual bool isPeriodic() const;
        virtual bool setPeriod(Seconds s) ;
        virtual unsigned getCpuAffinity() const;
        virtual bool setCpuAffinity(unsigned cpu) ;
        virtual bool execute();
        virtual bool trigger();
        virtual bool timeout() ;
        virtual os::ThreadInterface* thread();

        virtual void work(base::RunnableInterface::WorkReason reason);
    protected:
        Seconds                                 period;
        bool                                    running;
        base::RunnableInterface::WorkReason     lastReason;
    };
}}

#endif