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

#ifndef __COMMUNICATION_YARPSERVICEAYNCHREQUESTTYPE_H
#define __COMMUNICATION_YARPSERVICEAYNCHREQUESTTYPE_H

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

#include <yarp/os/all.h>


#include <ServiceRequest.hpp>

#include <string>

namespace mermaid
{
  namespace support
  {
    namespace communication
    {
    
      using boost::shared_ptr;
      using mermaid::support::service::ServiceRequest;
      
      using yarp::os::Bottle;
      using yarp::os::ConnectionReader;
      using yarp::os::ConnectionWriter;
      using yarp::os::Portable;
      
      /**
      * @Class YarpServiceAsynchRequestType YarpServiceAsynchRequestType.hpp "YarpServiceAsynchRequestType.hpp"
      * @Description YarpServiceAsynchRequestType class.
      * @Author Marco Barbosa
      */
      class YarpServiceAsynchRequestType : public Portable
      {
        public:
          YarpServiceAsynchRequestType();
          YarpServiceAsynchRequestType (std::string requesterEntityName, std::string requesterServiceName, std::string targetEntityName, std::string targetServiceName, std::string targetServiceInterfaceName, int requestId);
          YarpServiceAsynchRequestType (const YarpServiceAsynchRequestType &ysart);
          YarpServiceAsynchRequestType& operator= (const YarpServiceAsynchRequestType &ysart);
          
          virtual bool write (ConnectionWriter& connection);
          virtual bool read (ConnectionReader& connection);
          
          void setTargetEntityName (std::string targetEntityName);
          void setTargetServiceName (std::string targetServiceName);
          
          std::string getRequesterEntityName();
          std::string getRequesterServiceName();
          std::string getTargetEntityName();
          std::string getTargetServiceName();
          std::string getTargetServiceInterfaceName();
          int getRequestId();
          Bottle& getRequestData();
          
          //type conversion
          void convertFromServiceRequest (ServiceRequest &sar);
          shared_ptr<ServiceRequest> convertToServiceRequest();
          
          /*YarpServiceAsynchRequestType& operator=(ServiceRequest &sar);
          operator ServiceRequest ();*/
          
          
        private:
          //bool validData_;
          std::string requesterEntityName_;
          std::string requesterServiceName_;
          std::string targetEntityName_;
          std::string targetServiceName_;
          std::string targetServiceInterfaceName_;
          int requestId_;
          Bottle requestData_;
          
      }; // class YarpServiceAsynchRequestType
      
    } // namespace communication
  } // namespace support
} // namespace mermaid

#endif // __COMMUNICATION_YARPSERVICEAYNCHREQUESTTYPE_H