CommandC.hpp

00001 /***************************************************************************
00002   tag: Peter Soetens  Wed Jan 18 14:11:40 CET 2006  CommandC.hpp
00003 
00004                         CommandC.hpp -  description
00005                            -------------------
00006     begin                : Wed January 18 2006
00007     copyright            : (C) 2006 Peter Soetens
00008     email                : peter.soetens@mech.kuleuven.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_COMMANDC_HPP
00040 #define ORO_EXECUTION_COMMANDC_HPP
00041 
00042 #include <string>
00043 #include <utility>
00044 
00045 #include "DataSourceBase.hpp"
00046 #include "OperationFactory.hpp"
00047 
00048 namespace RTT
00049 {
00050     class ConditionInterface;
00051 
00055     class RTT_API CommandC
00056     {
00060         class D;
00061         D* d;
00062         DispatchInterface::shared_ptr cc;
00063     public:
00069         CommandC();
00070 
00075         CommandC( const CommandFactory* gcf, const std::string& name);
00076 
00080         CommandC(const CommandC& other);
00081 
00086         CommandC(DispatchInterface* di);
00087 
00092         CommandC(DispatchInterface::shared_ptr di);
00093 
00097         CommandC& operator=( const CommandC& other );
00098 
00099         ~CommandC();
00100 
00106         CommandC& arg( DataSourceBase::shared_ptr a );
00107 
00113         template< class ArgT >
00114         CommandC& argC( const ArgT a );
00115 
00122         template< class ArgT >
00123         CommandC& arg( ArgT& a );
00124 
00129         bool ready() const;
00130 
00139         bool execute();
00140 
00145         bool sent() const;
00146 
00152         bool accepted() const;
00153 
00159         bool executed() const;
00160 
00168         bool valid() const;
00169 
00176         bool done() const;
00177 
00182         void reset();
00183 
00184     };
00185 }
00186 
00187 #include "DataSources.hpp"
00188 
00189 namespace RTT
00190 {
00191 
00192         template< class ArgT >
00193         CommandC& CommandC::argC( const ArgT a )
00194         {
00195             return this->arg(DataSourceBase::shared_ptr( new ConstantDataSource<ArgT>( a ) ) );
00196         }
00197 
00198         template< class ArgT >
00199         CommandC& CommandC::arg( ArgT& a )
00200         {
00201             return this->arg(DataSourceBase::shared_ptr( new ReferenceDataSource<ArgT&>( a ) ) );
00202         }
00203 
00204 }
00205 
00206 #endif
Generated on Thu Dec 23 13:22:36 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3