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


#ifndef __SERVICE_SERVICEREQUEST_H
#define __SERVICE_SERVICEREQUEST_H

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

#include <DataBox.hpp>
#include <DataValueVector.hpp>


#include "ServiceRequestState.hpp"

namespace mermaid
{
  namespace support
  {
    namespace service
    {
    
      using mermaid::support::data::DataBox;
      using mermaid::support::data::DataValueVector;
      using boost::shared_ptr;
      
      /**
      * @Class ServiceRequest ServiceRequest.hpp "ServiceRequest.hpp"
      * @Description Class representing a Service Request
      * @Author Marco Barbosa
      */
      class ServiceRequest
      {
        public:
          ServiceRequest (std::string requesterEntityName, std::string requesterServiceName, std::string targetEntityName, std::string targetServiceName, std::string targetServiceInterfaceName, int requestId);
          ServiceRequest (const ServiceRequest &sar);
          ServiceRequest& operator= (const ServiceRequest &sar);
          
          std::string getRequesterEntityName();
          std::string getRequesterServiceName();
          std::string getTargetEntityName();
          std::string getTargetServiceName();
          std::string getTargetServiceInterfaceName();
          int getRequestId();
          
          shared_ptr<DataBox> getRequestDataBox();
          void setRequestDataBox (shared_ptr<DataBox> dataBox);
          
          ServiceRequestState& getState();
          void notifySent();
          void notifyReplyReceived();
          
        private:
        
          ServiceRequest();
          
          std::string requesterEntityName_;
          std::string requesterServiceName_;
          std::string targetEntityName_;
          std::string targetServiceName_;
          std::string targetServiceInterfaceName_;
          int requestId_;
          shared_ptr<DataBox> requestDataBox_;
          
          ServiceRequestState state_;
          
      }; // class ServiceRequest
    } // namespace service
  } // namespace support
} // namespace mermaid
#endif // __SERVICE_SERVICEREQUEST_H