vpRequest.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2025 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Network Request.
 */
 
#ifndef VP_REQUEST_H
#define VP_REQUEST_H
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpDebug.h>
#include <visp3/core/vpException.h>
#include <visp3/core/vpImageException.h>
 
#include <string.h>
#include <vector>
 
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpRequest
{
protected:
  std::string request_id;
  std::vector<std::string> listOfParams;
 
public:
  vpRequest();
  vpRequest(const vpRequest &req)
  {
    *this = req;
  }
  virtual ~vpRequest() { }
 
  vpRequest &operator=(const vpRequest &req)
  {
    request_id = req.request_id;
    listOfParams = req.listOfParams;
    return *this;
  }
 
  void addParameter(const char *params);
  void addParameter(const std::string &params);
  void addParameter(const std::vector<std::string> &listOfparams);
  template <typename T> void addParameterObject(T *params, const int &sizeOfObject = sizeof(T));

  virtual void decode() = 0;

  void clear() { listOfParams.clear(); }

  virtual void encode() = 0;

  inline std::string &operator[](const unsigned int &i) { return listOfParams[i]; }

  inline const std::string &operator[](const unsigned int &i) const { return listOfParams[i]; }

  std::string getId() const { return request_id; }

  void setId(const char *id) { request_id = id; }

  unsigned int size() const { return static_cast<unsigned int>(listOfParams.size()); }
};
 
//######## Definition of Template Functions ########
//#                                                #
//##################################################

template <typename T> void vpRequest::addParameterObject(T *params, const int &sizeOfObject)
{
  if (sizeOfObject != 0) {
    char *tempS = new char[sizeOfObject];
    memcpy((void *)tempS, (void *)params, sizeOfObject);
    std::string returnVal(tempS, static_cast<size_t>(sizeOfObject));
 
    listOfParams.push_back(returnVal);
 
    delete[] tempS;
  }
}
END_VISP_NAMESPACE
#endif