Orocos Real-Time Toolkit  2.5.0
OperationCallerC.hpp
00001 /***************************************************************************
00002   tag: Peter Soetens  Wed Jan 18 14:11:40 CET 2006  OperationCallerC.hpp
00003 
00004                         OperationCallerC.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_METHODC_HPP
00040 #define ORO_EXECUTION_METHODC_HPP
00041 
00042 #include <string>
00043 #include "DataSources.hpp"
00044 #include "../Attribute.hpp"
00045 #include "../rtt-fwd.hpp"
00046 #include "../SendStatus.hpp"
00047 #include "SendHandleC.hpp"
00048 
00049 namespace RTT
00050 { namespace internal {
00051 
00055     class RTT_API OperationCallerC
00056     {
00060         class D;
00061         D* d;
00062         base::DataSourceBase::shared_ptr m;
00063         base::DataSourceBase::shared_ptr s;
00064         OperationInterfacePart* ofp;
00065         std::string mname;
00066 
00067     public:
00073         OperationCallerC();
00074 
00079         OperationCallerC( OperationInterfacePart* mr, const std::string& name, ExecutionEngine* caller);
00080 
00084         OperationCallerC(const OperationCallerC& other);
00085 
00089         OperationCallerC& operator=(const OperationCallerC& other);
00090 
00091         ~OperationCallerC();
00092 
00098         OperationCallerC& arg( base::DataSourceBase::shared_ptr a );
00099 
00105         template< class ArgT >
00106         OperationCallerC& argC( const ArgT a )
00107         {
00108             return this->arg(base::DataSourceBase::shared_ptr( new ConstantDataSource<ArgT>( a ) ) );
00109         }
00110 
00117         template< class ArgT >
00118         OperationCallerC& arg( ArgT& a )
00119         {
00120             return this->arg(base::DataSourceBase::shared_ptr( new ReferenceDataSource<ArgT>( a ) ) );
00121         }
00122 
00127         OperationCallerC& ret( base::AttributeBase* r );
00128 
00133         OperationCallerC& ret( base::DataSourceBase::shared_ptr r);
00134 
00139         template< class RetT >
00140         OperationCallerC& ret( RetT& r )
00141         {
00142             // this is semantically valid wrt Attribute::copy().
00143             base::AttributeBase* ta = new Attribute<RetT>("ret", new ReferenceDataSource<RetT>(r));
00144             this->ret( ta );
00145             delete ta;
00146             return *this;
00147         }
00148 
00152         bool call();
00153 
00161         SendHandleC send();
00162 
00170         void check();
00171 
00175         bool ready() const;
00176 
00180         OperationInterfacePart* getOrp() const;
00181 
00185         std::string const& getName() const;
00186 
00190         base::DataSourceBase::shared_ptr getCallDataSource();
00194         base::DataSourceBase::shared_ptr getSendDataSource();
00198         base::DataSourceBase::shared_ptr getSendHandleDataSource();
00199     };
00200 }}
00201 
00202 #endif