Visual Servoing Platform version 3.5.0
vpException.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 * Exception handling.
33 *
34 * Authors:
35 * Nicolas Mansard
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/* --- INCLUDE --------------------------------------------------------- */
48/* --------------------------------------------------------------------- */
49
50#include <visp3/core/vpConfig.h>
51
52/* Classes standards. */
53#include <iostream> /* Classe std::ostream. */
54#include <stdarg.h>
55#include <string> /* Classe string. */
56
57/* --------------------------------------------------------------------- */
58/* --- CLASS ----------------------------------------------------------- */
59/* --------------------------------------------------------------------- */
60
71class VISP_EXPORT vpException : public std::exception
72{
73protected:
75 int code;
76
78 std::string message;
79
81 void setMessage(const char *format, va_list args);
82
84 vpException() : code(notInitialized), message(""){};
85
86public:
98 notInitialized
99 };
100
101 vpException(int code, const char *format, va_list args);
102 vpException(int code, const char *format, ...);
103 vpException(int code, const std::string &msg);
104 explicit vpException(int code);
105
110#if VISP_CXX_STANDARD > VISP_CXX_STANDARD_98
111 virtual ~vpException() {}
112#else
113 virtual ~vpException() throw() {}
114#endif
115
119 int getCode() const;
120
122 const std::string &getStringMessage() const;
125 const char *getMessage() const;
127
129 friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpException &art);
130
131 const char *what() const throw();
132};
133
134#endif /* #ifndef _vpException_h_ */
error that can be emited by ViSP classes.
Definition: vpException.h:72
int code
Contains the error code, see the errorCodeEnum table for details.
Definition: vpException.h:75
vpException()
forbid the empty constructor (protected)
Definition: vpException.h:84
@ ioError
I/O error.
Definition: vpException.h:91
@ cannotUseConstructorError
Contructor error.
Definition: vpException.h:92
@ badValue
Used to indicate that a value is not in the allowed range.
Definition: vpException.h:97
@ functionNotImplementedError
Function not implemented.
Definition: vpException.h:90
@ dimensionError
Bad dimension.
Definition: vpException.h:95
@ memoryFreeError
Memory free error.
Definition: vpException.h:89
@ notImplementedError
Not implemented.
Definition: vpException.h:93
@ memoryAllocationError
Memory allocation error.
Definition: vpException.h:88
@ fatalError
Fatal error.
Definition: vpException.h:96
@ divideByZeroError
Division by zero.
Definition: vpException.h:94
virtual ~vpException()
Definition: vpException.h:111
std::string message
Contains an error message (can be empty)
Definition: vpException.h:78