ProgramProcessor.hpp

/***************************************************************************
  tag: Peter Soetens  Thu Oct 10 16:19:04 CEST 2002  Processor.hpp

                        Processor.hpp -  description
                           -------------------
    begin                : Thu October 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 PROGRAM_PROCESSOR_HPP
#define PROGRAM_PROCESSOR_HPP

#include "RunnableInterface.hpp"
#include "BufferPolicy.hpp"
#include "List.hpp"
#include "ProgramExceptions.hpp"
#include "ProgramInterface.hpp"

#include <map>
#include <string>
#include <vector>
#include "os/Mutex.hpp"

namespace RTT
{
    template< class T, class RP, class WP>
    class Queue;
}

namespace RTT
{
    class RTT_API ProgramProcessor
        : public RunnableInterface
    {
    public:
        ProgramProcessor(int f_queue_size = ORONUM_EXECUTION_PROC_QUEUE_SIZE);

        virtual ~ProgramProcessor();

        typedef ProgramInterface::Status Status;

        bool loadProgram( ProgramInterfacePtr pi );

        bool deleteProgram(const std::string& name);

        bool unloadProgram(const std::string& name);

        void clear();

        Status::ProgramStatus getProgramStatus(const std::string& name) const;

        std::string getProgramStatusStr(const std::string& name) const;

        virtual bool initialize();
        virtual void step();
        virtual void finalize();

        virtual bool runFunction(ProgramInterface* f);

        virtual bool removeFunction(ProgramInterface* f);

        std::vector<std::string> getProgramList() const;

        const ProgramInterfacePtr getProgram(const std::string& name) const;

        ProgramInterfacePtr getProgram(const std::string& name);

    protected:
        typedef List<ProgramInterfacePtr> ProgMap;
        ProgMap* programs;

        std::vector<ProgramInterface*> funcs;

        Queue<ProgramInterface*,NonBlockingPolicy,NonBlockingPolicy>* f_queue;

        OS::Mutex syncer;
    };

}

#endif