DispatchInterface.hpp

/***************************************************************************
  tag: Peter Soetens  Mon Jun 26 13:25:57 CEST 2006  DispatchInterface.hpp

                        DispatchInterface.hpp -  description
                           -------------------
    begin                : Mon June 26 2006
    copyright            : (C) 2006 Peter Soetens
    email                : peter.soetens@fmtc.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_EXECUTION_DISPATCHINTERFACE_HPP
#define ORO_EXECUTION_DISPATCHINTERFACE_HPP

#include "CommandInterface.hpp"
#include "ConditionInterface.hpp"
#include <boost/shared_ptr.hpp>

namespace RTT
{
    class RTT_API DispatchInterface
        : public CommandInterface
    {
    public:
        typedef boost::shared_ptr<DispatchInterface> shared_ptr;

        enum Status { NotReady, 
                      Ready,    
                      Sent,     
                      NotAccepted, 
                      Accepted, 
                      Executed, 
                      NotValid, 
                      Valid,    
                      Done };   

        virtual bool ready() const = 0;

        virtual bool dispatch() = 0;

        virtual void reset() = 0;

        virtual bool sent() const = 0;

        virtual bool accepted() const = 0;

        virtual bool executed() const = 0;

        virtual bool valid() const = 0;

        virtual bool done() const = 0;

        virtual ConditionInterface* createCondition() const = 0;

        virtual DispatchInterface* clone() const = 0;

        virtual DispatchInterface* copy( std::map<const DataSourceBase*, DataSourceBase*>& alreadyCloned ) const {
            return this->clone();
        }
    };
}

#endif