ProgramInterface.hpp

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

                        ProgramInterface.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 PROGRAMINTERFACE_HPP
#define PROGRAMINTERFACE_HPP

#include <string>
#include <vector>
#include "DataSourceBase.hpp"
#include "AttributeBase.hpp"
#include <boost/shared_ptr.hpp>

namespace RTT
{
    class ProgramProcessor;
    class ProgramInterface;
    typedef boost::shared_ptr<ProgramInterface> ProgramInterfacePtr;
    typedef boost::weak_ptr<ProgramInterface> ProgramInterfaceWPtr;

    class RTT_API ProgramInterface
    {
    public:
        struct RTT_API Status {
            enum ProgramStatus { stopped, 
                                 running, 
                                 paused,  
                                 error,   
                                 unloaded 
            };
        };
    protected:
        Status::ProgramStatus pStatus;
        ProgramProcessor* pp;
        virtual void handleUnload();
    public:
        ProgramInterface(ProgramProcessor* progp = 0);

        virtual ~ProgramInterface();

        void setProgramProcessor(ProgramProcessor* progp);

        ProgramProcessor* getProgramProcessor() const { return pp; }

        virtual bool start() = 0;

        virtual bool pause() = 0;

        virtual bool step() = 0;

        virtual bool stop() = 0;

        virtual bool execute()= 0;

        virtual void reset() = 0;

        inline bool isRunning() const { return pStatus == Status::running; }

        inline bool isPaused() const { return pStatus == Status::paused; }

        inline bool isStopped() const { return pStatus == Status::stopped || pStatus == Status::unloaded ; }

        inline bool inError() const { return pStatus == Status::error; }

        virtual bool stepDone() const = 0;

        virtual int getLineNumber() const = 0;

        Status::ProgramStatus getStatus() const { return pStatus; }

        virtual std::string getText() const = 0;

        virtual const std::string& getName() const = 0;

        virtual std::vector<AttributeBase*> getArguments() const = 0;

        virtual ProgramInterface* copy( std::map<const DataSourceBase*, DataSourceBase*>& replacementdss ) const = 0;

        virtual ProgramInterface* clone() const = 0;
    };


}


#endif