ServiceInterfaceDescription.hpp

Go to the documentation of this file.

/*
Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico

This file is part of MeRMaID.

MeRMaID is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

MeRMaID is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
*/



/**
 * @Filename ServiceInterfaceDescription.hpp
 * @Description Support ServiceInterfaceDescription declaration
 * @Status Work in Progress
 * @Version $Id: ServiceInterfaceDescription.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer mafb
 */


#ifndef __SUPPORT_SERVICEINTERFACEDESCRIPTION_H
#define __SUPPORT_SERVICEINTERFACEDESCRIPTION_H

#include <string>

namespace mermaid
{
  namespace support
  {
    namespace service
    {
      /**
       * @Class ServiceInterfaceDescription ServiceInterfaceDescription.hpp "ServiceInterfaceDescription.hpp"
       * @Description This class holds a description of a Service interface
       * @Author Marco Barbosa
       */
      class ServiceInterfaceDescription// : public XmlConvertible
      {
        public:
          ServiceInterfaceDescription (std::string interfaceName, std::string interfaceComment, std::string inputDataName, std::string outputDataName);
          
          std::string getServiceInterfaceName();
          std::string getServiceInterfaceComment();
          std::string getServiceInterfaceInputDataName();
          std::string getServiceInterfaceOutputDataName();
        private:
          std::string interfaceName_;
          std::string interfaceComment_;
          std::string inputDataName_;
          std::string outputDataName_;
      };
    } // namespace service
  } // namespace support
} // namespace mermaid

#endif // __SUPPORT_SERVICEINTERFACEDESCRIPTION_H