PortNamingConvention.hpp

Go to the documentation of this file.
00001 /*
00002 Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico
00003 
00004 This file is part of MeRMaID.
00005 
00006 MeRMaID is free software: you can redistribute it and/or modify
00007 it under the terms of the GNU Lesser General Public License as published by
00008 the Free Software Foundation, either version 3 of the License, or
00009 (at your option) any later version.
00010 
00011 MeRMaID is distributed in the hope that it will be useful,
00012 but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014 GNU Lesser General Public License for more details.
00015 
00016 You should have received a copy of the GNU Lesser General Public License
00017 along with MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
00018 */
00019 
00020 
00021 
00022 /**
00023  * @Filename PortNamingConvention.hpp
00024  * @Description PortNamingConvention declaration
00025  * @Status Work in Progress
00026  * @Version $Id: PortNamingConvention.hpp 1 2011-03-04 18:13:18Z jreis $
00027  * @Maintainer
00028  */
00029 
00030 
00031 #ifndef __COMMUNICATION_PORTNAMINGCONVENTION_H
00032 #define __COMMUNICATION_PORTNAMINGCONVENTION_H
00033 
00034 #include <string>
00035 
00036 namespace mermaid
00037 {
00038   namespace support
00039   {
00040     namespace communication
00041     {
00042       /**
00043        * @Class PortNamingConvention PortNamingConvention.hpp "PortNamingConvention.hpp"
00044        * @Description Class where the conventional names for the YARP ports are defined.
00045        * @Author Marco Barbosa
00046        */
00047       class PortNamingConvention
00048       {
00049         public:
00050           //service request ports
00051           static std::string getServiceRequestRequestPortName (std::string requesterEntityName, std::string requesterServiceName, std::string targetEntityName, std::string targetServiceName);
00052           static std::string getServiceRequestInputPortName (std::string entityName, std::string serviceName);
00053           static std::string getServiceRequestOutputPortName (std::string entityName, std::string serviceName, std::string requesterEntityName, std::string requesterServiceName);
00054           static std::string getServiceRequestReplyPortName (std::string requesterEntityName, std::string requesterServiceName, std::string targetEntityName, std::string targetServiceName);
00055           
00056           //data feed ports
00057           static std::string getDataFeedOutputPortName (std::string producerEntityName, std::string producerServiceName, std::string producerDatafeedName);
00058           static std::string getDataFeedInputPortName (std::string consumerEntityName, std::string consumerServiceName, std::string producerEntityName, std::string producerServiceName, std::string producerDatafeedName);
00059       }; // class UrusNamingConvention
00060     } // namespace communication
00061   } // namespace support
00062 } // namespace mermaid
00063 
00064 #endif // __COMMUNICATION_PORTNAMINGCONVENTION_H