ExecutionAccess.hpp

00001 /***************************************************************************
00002   tag: FMTC  do nov 2 13:06:06 CET 2006  ExecutionAccess.hpp
00003 
00004                         ExecutionAccess.hpp -  description
00005                            -------------------
00006     begin                : do november 02 2006
00007     copyright            : (C) 2006 FMTC
00008     email                : peter.soetens@fmtc.be
00009 
00010  ***************************************************************************
00011  *   This library is free software; you can redistribute it and/or         *
00012  *   modify it under the terms of the GNU General Public                   *
00013  *   License as published by the Free Software Foundation;                 *
00014  *   version 2 of the License.                                             *
00015  *                                                                         *
00016  *   As a special exception, you may use this file as part of a free       *
00017  *   software library without restriction.  Specifically, if other files   *
00018  *   instantiate templates or use macros or inline functions from this     *
00019  *   file, or you compile this file and link it with other files to        *
00020  *   produce an executable, this file does not by itself cause the         *
00021  *   resulting executable to be covered by the GNU General Public          *
00022  *   License.  This exception does not however invalidate any other        *
00023  *   reasons why the executable file might be covered by the GNU General   *
00024  *   Public License.                                                       *
00025  *                                                                         *
00026  *   This library is distributed in the hope that it will be useful,       *
00027  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00028  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00029  *   Lesser General Public License for more details.                       *
00030  *                                                                         *
00031  *   You should have received a copy of the GNU General Public             *
00032  *   License along with this library; if not, write to the Free Software   *
00033  *   Foundation, Inc., 59 Temple Place,                                    *
00034  *   Suite 330, Boston, MA  02111-1307  USA                                *
00035  *                                                                         *
00036  ***************************************************************************/
00037 
00038 
00039 #ifndef ORO_EXECUTION_ACCESS_HPP
00040 #define ORO_EXECUTION_ACCESS_HPP
00041 
00042 #include <string>
00043 #include "rtt-config.h"
00044 
00045 namespace RTT
00046 {
00047     class TaskContext;
00048 
00054     class RTT_API ExecutionAccess
00055     {
00056     protected:
00057         TaskContext* tc;
00058 
00059     public:
00060         ExecutionAccess( TaskContext* parent );
00061 
00062         virtual ~ExecutionAccess();
00063 
00072         bool startProgram(const std::string& name);
00073 
00078         bool stopProgram(const std::string& name);
00079 
00084         bool pauseProgram(const std::string& name);
00085 
00090         bool stepProgram(const std::string& name);
00106         virtual bool hasProgram(const std::string& name) const;
00107 
00115         bool isProgramRunning(const std::string& name) const;
00116 
00124         bool isProgramPaused(const std::string& name) const;
00125 
00133         bool inProgramError(const std::string& name) const;
00146         bool activateStateMachine(const std::string& name);
00147 
00152         bool deactivateStateMachine(const std::string& name);
00153 
00158         bool startStateMachine(const std::string& name);
00159 
00164         bool pauseStateMachine(const std::string& name);
00165 
00170         bool stopStateMachine(const std::string& name);
00171 
00176         bool resetStateMachine(const std::string& name);
00177 
00184         bool requestStateMachineState(const std::string& name, const std::string& state);
00200         virtual bool hasStateMachine(const std::string& name) const;
00201 
00206         bool isStateMachineActive(const std::string& name) const;
00207 
00212         bool isStateMachineRunning(const std::string& name) const;
00213 
00218         bool inStateMachineError(const std::string& name) const;
00219 
00224         bool isStateMachinePaused(const std::string& name) const;
00225 
00230         const std::string& getStateMachineState(const std::string& name) const;
00231 
00238         bool inStateMachineState(const std::string& name, const std::string& state) const;
00243         bool true_gen() const;
00244     };
00245 
00246 }
00247 
00248 #endif