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

#ifndef __COMMUNICATION_YARPSERVICEASYNCHREPLYTYPE_H
#define __COMMUNICATION_YARPSERVICEASYNCHREPLYTYPE_H

namespace mermaid
{
  namespace support
  {
    namespace communication
    {
      class YarpServiceAsynchReplyType;
    }
  }
}

#include <yarp/os/all.h>


#include <ServiceReply.hpp>
#include <ServiceRequest.hpp>

namespace mermaid
{
  namespace support
  {
    namespace communication
    {
    
      using boost::shared_ptr;
      using mermaid::support::service::ServiceReply;
      using mermaid::support::service::ServiceRequest;
      
      using yarp::os::Bottle;
      using yarp::os::ConnectionReader;
      using yarp::os::ConnectionWriter;
      using yarp::os::Portable;
      
      /**
      * @Class YarpServiceAsynchReplyType YarpServiceAsynchReplyType.hpp "YarpServiceAsynchReplyType.hpp"
      * @Description YarpServiceAsynchReplyType class.
      * @Author Marco Barbosa
      */
      class YarpServiceAsynchReplyType : public Portable
      {
        public:
          YarpServiceAsynchReplyType();
          YarpServiceAsynchReplyType (const YarpServiceAsynchReplyType &ysart);
          YarpServiceAsynchReplyType& operator= (const YarpServiceAsynchReplyType &ysart);
          
          //YarpServiceAsynchReplyType(int requestId);
          virtual bool write (ConnectionWriter& connection);
          virtual bool read (ConnectionReader& connection);
          
          virtual std::string getRequesterEntityName();
          virtual std::string getRequesterServiceName();
          virtual std::string getTargetEntityName();
          virtual std::string getTargetServiceName();
          virtual std::string getTargetServiceInterfaceName();
          virtual int getRequestId();
          
          
          //type conversion
          void convertFromServiceReply (ServiceReply &sr);
          shared_ptr<ServiceReply> convertToServiceReply (shared_ptr<ServiceRequest> originalRequest);
          
          //
          Bottle& getReplyData();
          
        private:
          std::string requesterEntityName_;
          std::string requesterServiceName_;
          std::string targetEntityName_;
          std::string targetServiceName_;
          std::string targetServiceInterfaceName_;
          int requestId_;
          std::string executionStatus_;
          Bottle replyData_;
      }; // class YarpServiceAsynchReplyType
    } // namespace communication
  } // namespace support
} // namespace mermaid
#endif // __COMMUNICATION_YARPSERVICEASYNCHREPLYTYPE_H