ServiceInstanceDescription.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 ServiceInstanceDescription.hpp
 * @Description Support ServiceInstanceDescription declaration
 * @Status Work in Progress
 * @Version $Id: ServiceInstanceDescription.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer mafb
 */


#ifndef __SUPPORT_SERVICEINSTANCEDESCRIPTION_H
#define __SUPPORT_SERVICEINSTANCEDESCRIPTION_H

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

#include <EntityDescription.hpp>
#include <ServiceTypeDescription.hpp>


#include <map>
#include <string>
#include <vector>

namespace mermaid
{
  namespace support
  {
    namespace service
    {
      using boost::shared_ptr;
      
      /**
       * @Class ServiceInstanceDescription ServiceInstanceDescription.hpp "ServiceInstanceDescription.hpp"
       * @Description This class holds a description of a Service instance
       * @Author Marco Barbosa
       */
      class ServiceInstanceDescription
      {
        public:
          ServiceInstanceDescription (shared_ptr<EntityDescription> entityDescription, std::string serviceInstanceName);
          
          void addServiceTypeDescription (shared_ptr<ServiceTypeDescription> serviceTypeDescription);
          shared_ptr<EntityDescription> getEntityDescription();
          std::vector<shared_ptr<ServiceTypeDescription> > getServiceTypeDescriptions();
          shared_ptr<ServiceTypeDescription> getServiceTypeDescriptionWithInterfaceName (std::string interfaceName);
          shared_ptr<ServiceTypeDescription> getServiceTypeDescriptionWithDataFeedName (std::string dataFeedName);
          std::string getServiceInstanceName();
          
        private:
          shared_ptr<EntityDescription> entityDescription_;
          std::map<std::string, shared_ptr<ServiceTypeDescription> > serviceTypeDescriptions_;
          std::string serviceInstanceName_;
      }; // ServiceInstanceDescription
    } // namespace service
  } // namespace support
} // namespace mermaid

#endif // __SUPPORT_SERVICEINSTANCEDESCRIPTION_H