Orocos Real-Time Toolkit  2.5.0
ServiceRequester.hpp
00001 /***************************************************************************
00002   tag: The SourceWorks  Tue Sep 7 00:55:18 CEST 2010  ServiceRequester.hpp
00003 
00004                         ServiceRequester.hpp -  description
00005                            -------------------
00006     begin                : Tue September 07 2010
00007     copyright            : (C) 2010 The SourceWorks
00008     email                : peter@thesourceworks.com
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_SERVICEREQUESTER_HPP_
00040 #define ORO_SERVICEREQUESTER_HPP_
00041 
00042 #include "rtt-config.h"
00043 #include "rtt-fwd.hpp"
00044 #include "base/OperationCallerBaseInvoker.hpp"
00045 #include "Service.hpp"
00046 #include <map>
00047 #include <vector>
00048 #include <string>
00049 
00050 namespace RTT
00051 {
00064     class RTT_API ServiceRequester
00065     {
00066     public:
00067         typedef std::vector<std::string> RequesterNames;
00068         typedef std::vector<std::string> OperationCallerNames;
00069         ServiceRequester(const std::string& name, TaskContext* owner = 0);
00070         virtual ~ServiceRequester();
00071 
00072         const std::string& getRequestName() const { return mrname; }
00073 
00074         RequesterNames getRequesterNames() const;
00075 
00080         TaskContext* getServiceOwner() const { return mrowner; }
00081 
00088         Service::shared_ptr getReferencedService();
00089 
00090         bool addOperationCaller( base::OperationCallerBaseInvoker& mbi);
00091 
00092         OperationCallerNames getOperationCallerNames() const;
00093 
00094         base::OperationCallerBaseInvoker* getOperationCaller(const std::string& name);
00095 
00096         ServiceRequester* requires() { return this; }
00097 
00098         ServiceRequester* requires(const std::string& service_name) {
00099             ServiceRequester* sp = mrequests[service_name];
00100             if (sp)
00101                 return sp;
00102             sp = new ServiceRequester(service_name, mrowner);
00103             mrequests[service_name] = sp;
00104             return sp;
00105         }
00106 
00112         bool requiresService(const std::string& service_name) {
00113             return mrequests.find(service_name) != mrequests.end();
00114         }
00115 
00127         bool connectTo(Service::shared_ptr sp);
00128 
00133         bool ready() const;
00134 
00138         void disconnect();
00139 
00140     protected:
00141         typedef std::map< std::string, ServiceRequester* > Requests;
00143         Requests mrequests;
00144 
00146         typedef std::map<std::string, base::OperationCallerBaseInvoker*> OperationCallers;
00147         OperationCallers mmethods;
00148 
00149         std::string mrname;
00150         TaskContext* mrowner;
00151         Service::shared_ptr mprovider;
00152     };
00153 }
00154 
00155 #endif /* ORO_SERVICEREQUESTER_HPP_ */