CommandDispatch.hpp

/***************************************************************************
  tag: Peter Soetens  Tue Dec 21 22:43:07 CET 2004  CommandDispatch.hpp

                        CommandDispatch.hpp -  description
                           -------------------
    begin                : Tue December 21 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 EXECUTION_COMMAND_DISPATCH
#define EXECUTION_COMMAND_DISPATCH

#include "DataSource.hpp"
#include "DispatchInterface.hpp"
#include "ConditionInterface.hpp"


namespace RTT
{
    class TryCommand;
    class CommandProcessor;

    class RTT_API CommandDispatch
        : public DispatchInterface
    {
        bool send;
        bool maccepted;
        CommandProcessor* proc;
        CommandInterface* com;
        ConditionInterface* mcn;

        struct Dispatcher : public CommandInterface {
            bool mexecuted, mvalid;
            CommandDispatch* cd;
            // trick: set mvalid to true internally but return in valid(): mexecuted && mvalid.
            Dispatcher(CommandDispatch* c) : mexecuted(false), mvalid(true), cd(c) {}
            void readArguments() {}
            bool execute() { mvalid=cd->com->execute(); mexecuted=true; return mvalid;}
            void reset() { mexecuted=false; mvalid=true; }
            virtual Dispatcher* clone() const { return new Dispatcher(cd); }
        } dispatcher;

    public:
        CommandDispatch(CommandProcessor* p, CommandInterface* c, ConditionInterface* cn );

        ~CommandDispatch();

        void readArguments();

        bool ready() const;

        bool execute();

        bool dispatch();

        void reset();

        bool sent() const;

        bool accepted() const;

        bool executed() const;

        bool valid() const;

        bool done() const;

        virtual ConditionInterface* createCondition() const;

        DispatchInterface* clone() const;

        DispatchInterface* copy( std::map<const DataSourceBase*, DataSourceBase*>& alreadyCloned ) const;
    };
}

#endif