Visual Servoing Platform  version 3.4.0 under development (2021-04-12)
vpXmlParserCamera.h
1 /****************************************************************************
2  *
3  * ViSP, open source Visual Servoing Platform software.
4  * Copyright (C) 2005 - 2019 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  * See the file LICENSE.txt at the root directory of this source
11  * distribution for additional information about the GNU GPL.
12  *
13  * For using ViSP with software that can not be combined with the GNU
14  * GPL, please contact Inria about acquiring a ViSP Professional
15  * Edition License.
16  *
17  * See http://visp.inria.fr for more information.
18  *
19  * This software was developed at:
20  * Inria Rennes - Bretagne Atlantique
21  * Campus Universitaire de Beaulieu
22  * 35042 Rennes Cedex
23  * France
24  *
25  * If you have questions regarding the use of this file, please contact
26  * Inria at visp@inria.fr
27  *
28  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
29  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
30  *
31  * Description:
32  * XML parser to load and save camera intrinsic parameters.
33  *
34  *****************************************************************************/
35 
43 #ifndef vpXMLPARSERCAMERA_H
44 #define vpXMLPARSERCAMERA_H
45 
46 #include <visp3/core/vpConfig.h>
47 
48 #include <visp3/core/vpCameraParameters.h>
49 
164 class VISP_EXPORT vpXmlParserCamera
165 {
166 public:
167  enum vpXmlCodeSequenceType { SEQUENCE_OK, SEQUENCE_ERROR };
168 
171 
172  // get/set functions
173  std::string getCameraName() const;
174  vpCameraParameters getCameraParameters() const;
175  unsigned int getHeight() const;
176  unsigned int getSubsampling_width() const;
177  unsigned int getSubsampling_height() const;
178  unsigned int getWidth() const;
179 
180  int parse(vpCameraParameters &cam, const std::string &filename, const std::string &camera_name,
181  const vpCameraParameters::vpCameraParametersProjType &projModel, unsigned int image_width = 0,
182  unsigned int image_height = 0);
183 
184  int save(const vpCameraParameters &cam, const std::string &filename, const std::string &camera_name,
185  unsigned int image_width = 0, unsigned int image_height = 0,
186  const std::string &additionalInfo = "");
187 
188  void setCameraName(const std::string &name);
189  void setHeight(unsigned int height);
190  void setSubsampling_width(unsigned int subsampling);
191  void setSubsampling_height(unsigned int subsampling);
192  void setWidth(unsigned int width);
193 
194 private:
195  vpXmlParserCamera(const vpXmlParserCamera &); // noncopyable
196  vpXmlParserCamera &operator=(const vpXmlParserCamera &); //
197 
198  // PIMPL idiom
199  class Impl;
200  Impl *m_impl;
201 };
202 #endif
XML parser to load and save intrinsic camera parameters.
Generic class defining intrinsic camera parameters.