#include <visp3/core/vpRequest.h>

Public Member Functions
	vpRequest ()

virtual	~vpRequest ()

void	addParameter (char *params)

void	addParameter (std::string &params)

void	addParameter (std::vector< std::string > &listOfparams)

template<typename T >
void	addParameterObject (T *params, const int &sizeOfObject=sizeof(T))

virtual void	decode ()=0

void	clear ()

virtual void	encode ()=0

std::string &	operator[] (const unsigned int &i)

const std::string &	operator[] (const unsigned int &i) const

std::string	getId ()

void	setId (const char *id)

unsigned int	size ()

Protected Attributes
std::string	request_id

std::vector< std::string >	listOfParams

Detailed Description

This the request that will transit on the network.

Exemple request decoding an image on a specific form. First parameter : Height of the image. Second parameter : Width of the image. Thirs parameter : Bitmap of the image (not compress).

Here is the header of the vpRequestImage class.

#ifndef vpRequestImage_H
#define vpRequestImage_H
#include <visp3/core/vpImage.h>
#include <visp3/core/vpRequest.h>
class vpRequestImage : public vpRequest
{
private:
  vpImage<unsigned char> *I;
  
public:
  vpRequestImage();
  vpRequestImage(vpImage<unsigned char> *);
  ~vpRequestImage();
  
  virtual void encode();
  virtual void decode();
};
#endif

Here is the definition of the vpRequestImage class.

#include <vpRequestImage.h>
vpRequestImage::vpRequestImage(){
  request_id = "image";
}
vpRequestImage::vpRequestImage(vpImage<unsigned char> *Im){
  request_id = "image";
  I = Im;
}
vpRequestImage::~vpRequestImage(){}
void vpRequestImage::encode(){
  clear(); 
  
  unsigned int h = I->getHeight();
  unsigned int w = I->getWidth();     
  addParameterObject(&h);
  addParameterObject(&w);
  addParameterObject(I->bitmap,h*w*sizeof(unsigned char));
}
  
void vpRequestImage::decode(){
  if(listOfParams.size() == 3){
    unsigned int w, h;
    memcpy((void*)&h, (void*)listOfParams[0].c_str(), sizeof(unsigned int));
    memcpy((void*)&w, (void*)listOfParams[1].c_str(), sizeof(unsigned int));
    
    I->resize(h,w);
    memcpy((void*)I->bitmap,(void*)listOfParams[2].c_str(),w*h*sizeof(unsigned char));
  }
}

See Also: vpClient; vpServer; vpNetwork

Definition at line 130 of file vpRequest.h.

Constructor & Destructor Documentation

vpRequest::vpRequest ( )

Definition at line 40 of file vpRequest.cpp.

vpRequest::~vpRequest ( )

virtual

Definition at line 44 of file vpRequest.cpp.

Member Function Documentation

void vpRequest::addParameter ( char * params )

Add a message as parameter of the request.

See Also: vpNetwork::addParameterObject()

Parameters

params : Array of characters representing the message to add.

Definition at line 54 of file vpRequest.cpp.

References listOfParams.

void vpRequest::addParameter ( std::string & params )

Add a message as parameter of the request.

See Also: vpNetwork::addParameterObject()

Parameters

params : std::string representing the message to add.

Definition at line 67 of file vpRequest.cpp.

References listOfParams.

void vpRequest::addParameter ( std::vector< std::string > & listOfparams )

Add messages as parameters of the request. Each message corresponds to one parameter.

See Also: vpNetwork::addParameterObject()

Parameters

listOfparams : Array of std::string representing the messages to add.

Definition at line 80 of file vpRequest.cpp.

template<typename T >

void vpRequest::addParameterObject	(	T *	params,
		const int &	sizeOfObject = `sizeof(T)`
	)

Add an object as parameter of the request.

Warning: Only simple object can be sent unless you know its size. Sending object containing pointers, virtual methods, etc, won't probably work. Unless the size is well defined...