ServiceTypeDescription.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 ServiceTypeDescription.hpp
 * @Description Support ServiceTypeDescription declaration
 * @Status Work in Progress
 * @Version $Id: ServiceTypeDescription.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer nmsra (nmsra@mega.ist.utl.pt)
 */


#ifndef __SUPPORT_SERVICETYPEDESCRIPTION_H
#define __SUPPORT_SERVICETYPEDESCRIPTION_H

namespace mermaid
{
  namespace support
  {
    namespace service
    {
      class ServiceTypeDescription;
    }
  }
}

#include "ServiceInterfaceDescription.hpp"
#include "DataFeedDescription.hpp"


#include <XmlCharData.hpp>
#include <XmlConvertible.hpp>
#include <XmlDocument.hpp>
#include <XmlElement.hpp>
#include <XmlElementVector.hpp>

#include <map>
#include <vector>

namespace mermaid
{
  namespace support
  {
    namespace service
    {
    
      using boost::shared_ptr;
      using mermaid::support::xml::XmlCharData;
      using mermaid::support::xml::XmlConvertible;
      using mermaid::support::xml::XmlDocument;
      using mermaid::support::xml::XmlElement;
      using mermaid::support::xml::XmlElementVector;
      
      //forward declaration
      class Entity;
      class ServiceInterfaceDescription;
      
      /**
      * @Class ServiceTypeDescription ServiceTypeDescription.hpp "ServiceTypeDescription.hpp"
      * @Description This class holds a description of a Service type
      * @Author Marco Barbosa
      */
      class ServiceTypeDescription
      {
      
        public:
        
          ServiceTypeDescription (std::string serviceTypeName, std::string serviceTypeComment);
          
          std::string getServiceTypeName();
          std::string getServiceTypeComment();
          void addServiceInterfaceDescription (shared_ptr<ServiceInterfaceDescription> interfaceDescription);
          shared_ptr<ServiceInterfaceDescription> getServiceInterfaceDescription (std::string interfaceName);
          std::vector< shared_ptr<ServiceInterfaceDescription> > getAllServiceInterfaceDescriptions();
          void addDataFeedDescription (shared_ptr<DataFeedDescription> dataFeedDescription);
          shared_ptr<DataFeedDescription> getDataFeedDescription (std::string dataFeedName);
          std::vector< shared_ptr<DataFeedDescription> > getAllDataFeedDescriptions();
          
        private:
          std::string serviceTypeName_;
          std::string serviceTypeComment_;
          std::map<std::string, shared_ptr<ServiceInterfaceDescription> > interfaceDescriptionMap_;
          std::map<std::string, shared_ptr<DataFeedDescription> > dataFeedDescriptionMap_;
      }; // class ServiceDescription
    } // namespace service
  } // namespace support
} // namespace mermaid

#endif // __SUPPORT_SERVICETYPEDESCRIPTION_H
//#include "Entity.hpp"