DataFlowInterface.hpp

00001 /***************************************************************************
00002   tag: Peter Soetens  Thu Mar 2 08:30:18 CET 2006  DataFlowInterface.hpp
00003 
00004                         DataFlowInterface.hpp -  description
00005                            -------------------
00006     begin                : Thu March 02 2006
00007     copyright            : (C) 2006 Peter Soetens
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_DATA_FLOW_INTERFACE_HPP
00040 #define ORO_EXECUTION_DATA_FLOW_INTERFACE_HPP
00041 
00042 #include <vector>
00043 #include <map>
00044 #include <string>
00045 #include "PortInterface.hpp"
00046 #include "OperationInterface.hpp"
00047 
00048 namespace RTT
00049 {
00050 
00055     class RTT_API DataFlowInterface
00056     {
00057     public:
00061         typedef std::vector<PortInterface*> Ports;
00062 
00066         typedef std::vector<std::string> PortNames;
00067 
00073         DataFlowInterface(OperationInterface* parent = 0);
00074 
00075         ~DataFlowInterface();
00076 
00084         bool addPort(PortInterface* port);
00085 
00095         bool addEventPort(PortInterface* port, PortInterface::NewDataOnPortEvent::SlotFunction callback = PortInterface::NewDataOnPortEvent::SlotFunction() );
00096 
00101         const Ports& getEventPorts() const;
00102 
00109         bool addPort(PortInterface* port, std::string description);
00110 
00120         bool addEventPort(PortInterface* port, std::string description, PortInterface::NewDataOnPortEvent::SlotFunction callback = PortInterface::NewDataOnPortEvent::SlotFunction() );
00121 
00126         void removePort(const std::string& name);
00127 
00132         Ports getPorts() const;
00133 
00139         PortNames getPortNames() const;
00140 
00145         PortNames getNames() const;
00146 
00152         PortInterface* getPort(const std::string& name) const;
00153 
00161         std::string getPortDescription(const std::string& name) const;
00162 
00170         OperationInterface* createPortObject(const std::string& name);
00171 
00175         template< class Type>
00176         Type* getPortType(const std::string& name) {
00177             return dynamic_cast<Type*>( this->getPort(name) );
00178         }
00179 
00184         void clear();
00185     protected:
00186         typedef std::vector<std::pair<PortInterface*,std::string> > PortStore;
00187         Ports eports;
00188         PortStore mports;
00189         OperationInterface* mparent;
00190 
00191     };
00192 
00193 }
00194 
00195 #endif
Generated on Thu Dec 23 13:22:37 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3