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 ORO_PROGRAMINTERFACE_HPP
#define ORO_PROGRAMINTERFACE_HPP

#include <string>
#include <vector>
#include <boost/shared_ptr.hpp>
#include "../base/DataSourceBase.hpp"
#include "../base/AttributeBase.hpp"
#include "../base/ExecutableInterface.hpp"
#include "rtt-scripting-config.h"
#include "../rtt-fwd.hpp"
#include "rtt-scripting-fwd.hpp"

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

    class RTT_SCRIPTING_API ProgramInterface
        : public base::ExecutableInterface
    {
    public:
        struct RTT_SCRIPTING_API Status {
            enum ProgramStatus {
                unknown = 0, 
                stopped, 
                paused,  
                running, 
                error    
            };
        };
    protected:
        Status::ProgramStatus pStatus;
    public:
        ProgramInterface();

        virtual ~ProgramInterface();

        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; }

        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<base::AttributeBase*> getArguments() const = 0;

        virtual base::AttributeBase* getResult() const = 0;

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

        virtual ProgramInterface* clone() const = 0;

        virtual bool needsStart() const = 0;

    };


}}


#endif