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


#ifndef __SUPPORT_ENTITYDESCRIPTION_H
#define __SUPPORT_ENTITYDESCRIPTION_H

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

#include "ServiceInstanceDescription.hpp"

#include <map>
#include <vector>
#include <string>
#include <boost/shared_ptr.hpp>

namespace mermaid
{
  namespace support
  {
    namespace service
    {
      using boost::shared_ptr;
      
      /**
       * @Class EntityDescription EntityDescription.hpp "EntityDescription.hpp"
       * @Description Class holding the description of an Entity
       * @Author Marco Barbosa
       */
      class EntityDescription
      {
        public:
        
          EntityDescription (std::string entityName);
          
          std::string getEntityName();
          void addServiceInstanceDescription (shared_ptr<ServiceInstanceDescription> serviceInstanceDescription);
          shared_ptr<ServiceInstanceDescription> getServiceInstanceDescription (std::string serviceInstanceName);
          std::vector<shared_ptr<ServiceInstanceDescription> > getAllServiceInstanceDescriptions();
          
        private:
          std::string entityName_;
          std::map<std::string, shared_ptr<ServiceInstanceDescription> > serviceMap_; // map from service instance names to service instance descriptions
      }; // EntityDescription
    } // namespace service
  } // namespace support
} // namespace mermaid

#endif // __SUPPORT_ENTITYDESCRIPTION_H