Visual Servoing Platform  version 3.0.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
vpException.h
1 /****************************************************************************
2  *
3  * This file is part of the ViSP software.
4  * Copyright (C) 2005 - 2017 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * ("GPL") version 2 as published by the Free Software Foundation.
9  * See the file LICENSE.txt at the root directory of this source
10  * distribution for additional information about the GNU GPL.
11  *
12  * For using ViSP with software that can not be combined with the GNU
13  * GPL, please contact Inria about acquiring a ViSP Professional
14  * Edition License.
15  *
16  * See http://visp.inria.fr for more information.
17  *
18  * This software was developed at:
19  * Inria Rennes - Bretagne Atlantique
20  * Campus Universitaire de Beaulieu
21  * 35042 Rennes Cedex
22  * France
23  *
24  * If you have questions regarding the use of this file, please contact
25  * Inria at visp@inria.fr
26  *
27  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
28  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
29  *
30  * Description:
31  * Exception handling.
32  *
33  * Authors:
34  * Nicolas Mansard
35  *
36  *****************************************************************************/
37 
38 
39 /* \file vpException.h
40  \brief error that can be emited by the vp class and its derivates
41  */
42 
43 #ifndef __vpException_H
44 #define __vpException_H
45 
46 
47 /* --------------------------------------------------------------------- */
48 /* --- INCLUDE --------------------------------------------------------- */
49 /* --------------------------------------------------------------------- */
50 
51 #include <visp3/core/vpConfig.h>
52 
53 /* Classes standards. */
54 #include <iostream> /* Classe std::ostream. */
55 #include <string> /* Classe string. */
56 #include <stdarg.h>
57 
58 /* --------------------------------------------------------------------- */
59 /* --- CLASS ----------------------------------------------------------- */
60 /* --------------------------------------------------------------------- */
61 
62 
73 class VISP_EXPORT vpException : public std::exception
74 {
75  protected:
76 
78  int code;
79 
81  std::string message;
82 
84  void setMessage(const char* format, va_list args);
85 
87  vpException(): code(notInitialized), message("") { };
88 
89  public:
90 
92  {
103  notInitialized
104  } ;
105 
106  vpException (const int code, const char* format, va_list args);
107  vpException (const int code, const char* format, ...);
108  vpException (const int code, const std::string & msg);
109  vpException (const int code);
110 
115  virtual ~vpException() throw() {}
116 
119  int getCode (void);
121 
123  const std::string &getStringMessage (void) const;
126  const char *getMessage (void) const;
128 
130  friend VISP_EXPORT std::ostream & operator << (std::ostream & os, const vpException & art);
131 
132  const char* what () const throw();
133 };
134 
135 #endif /* #ifndef __vpException_H */
error that can be emited by ViSP classes.
Definition: vpException.h:73
std::string message
Contains an error message (can be empty)
Definition: vpException.h:81
int code
Contains the error code, see the errorCodeEnum table for details.
Definition: vpException.h:78
vpException()
forbid the empty constructor (protected)
Definition: vpException.h:87
virtual ~vpException()
Definition: vpException.h:115