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

#ifndef __SERVICE_SERVICEASYNCHREPLY_H
#define __SERVICE_SERVICEASYNCHREPLY_H

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

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


#include "ServiceRequest.hpp"

namespace mermaid
{
  namespace support
  {
    namespace service
    {
    
      using mermaid::support::data::DataBox;
      using mermaid::support::data::DataValueVector;
      using boost::shared_ptr;
      
      /**
      * @Class ServiceReply ServiceReply.hpp "ServiceReply.hpp"
      * @Description Class representing a Service Reply
      * @Author Marco Barbosa
      */
      class ServiceReply
      {
        public:
          ServiceReply (shared_ptr<ServiceRequest> originalRequest, std::string executionStatus = "OK");
          ServiceReply (const ServiceReply &sr);
          ServiceReply& operator= (const ServiceReply &sr);
          
          
          std::string getRequesterEntityName();
          std::string getRequesterServiceName();
          std::string getTargetEntityName();
          std::string getTargetServiceName();
          std::string getTargetServiceInterfaceName();
          int getRequestId();
          bool executionIsOk();
          std::string getExecutionStatus();
          
          //shared_ptr<DataValueVector> getReplyValueVector();
          //void setReplyValueVector(shared_ptr<DataValueVector> valueVector);
          shared_ptr<DataBox> getReplyDataBox();
          void setReplyDataBox (shared_ptr<DataBox> dataBox);
          //void setReplyDataStructure(std::string structureName);
          
        protected:
        
          ServiceReply();
          
          std::string requesterEntityName_;
          std::string requesterServiceName_;
          std::string targetEntityName_;
          std::string targetServiceName_;
          std::string targetServiceInterfaceName_;
          int requestId_;
          std::string executionStatus_;
          //shared_ptr<DataValueVector> replyValueVector_;
          shared_ptr<DataBox> replyDataBox_;
          std::string dataStructureName_;
          
      }; // class ServiceRequest
      
    } // namespace service
  } // namespace support
} // namespace mermaid
#endif // __SERVICE_SERVICEASYNCHREPLY_H