vpXmlParserCamera.h

/****************************************************************************
 *
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2019 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 http://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:
 * XML parser to load and save camera intrinsic parameters.
 *
 *****************************************************************************/

#ifndef vpXMLPARSERCAMERA_H
#define vpXMLPARSERCAMERA_H

#include <visp3/core/vpConfig.h>

#include <visp3/core/vpCameraParameters.h>

class VISP_EXPORT vpXmlParserCamera
{
public:
  enum vpXmlCodeSequenceType { SEQUENCE_OK, SEQUENCE_ERROR };

  vpXmlParserCamera();
  ~vpXmlParserCamera();

  // get/set functions
  std::string getCameraName() const;
  vpCameraParameters getCameraParameters() const;
  unsigned int getHeight() const;
  unsigned int getSubsampling_width() const;
  unsigned int getSubsampling_height() const;
  unsigned int getWidth() const;

  int parse(vpCameraParameters &cam, const std::string &filename, const std::string &camera_name,
            const vpCameraParameters::vpCameraParametersProjType &projModel, unsigned int image_width = 0,
            unsigned int image_height = 0);

  int save(const vpCameraParameters &cam, const std::string &filename, const std::string &camera_name,
           unsigned int image_width = 0, unsigned int image_height = 0,
           const std::string &additionalInfo = "");

  void setCameraName(const std::string &name);
  void setHeight(unsigned int height);
  void setSubsampling_width(unsigned int subsampling);
  void setSubsampling_height(unsigned int subsampling);
  void setWidth(unsigned int width);

private:
  vpXmlParserCamera(const vpXmlParserCamera &);            // noncopyable
  vpXmlParserCamera &operator=(const vpXmlParserCamera &); //

  // PIMPL idiom
  class Impl;
  Impl *m_impl;
};
#endif