Visual Servoing Platform  version 3.6.1 under development (2024-11-14)
vpException.cpp
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
4  *
5  * This software is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
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 https://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 
39 #include "visp3/core/vpException.h"
40 #include <stdio.h>
41 
42 BEGIN_VISP_NAMESPACE
43 vpException::vpException(int id) : code(id), message() { }
44 
45 vpException::vpException(int id, const std::string &msg) : code(id), message(msg) { }
46 
47 vpException::vpException(int id, const char *format, ...) : code(id), message()
48 {
49  va_list args;
50  va_start(args, format);
51  setMessage(format, args);
52  va_end(args);
53 }
54 
55 vpException::vpException(int id, const char *format, va_list args) : code(id), message() { setMessage(format, args); }
56 
57 void vpException::setMessage(const char *format, va_list args)
58 {
59  char buffer[FILENAME_MAX];
60  vsnprintf(buffer, FILENAME_MAX, format, args);
61  std::string msg(buffer);
62  message = msg;
63 }
64 
65 const char *vpException::getMessage() const { return (this->message).c_str(); }
66 
67 const std::string &vpException::getStringMessage() const { return this->message; }
68 
69 int vpException::getCode() const { return this->code; }
70 
71 const char *vpException::what() const throw() { return (this->message).c_str(); }
72 
73 VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpException &error)
74 {
75  os << "Error [" << error.code << "]:\t" << error.message << std::endl;
76 
77  return os;
78 }
79 END_VISP_NAMESPACE
friend std::ostream & operator<<(std::ostream &s, const vpArray2D< Type > &A)
Definition: vpArray2D.h:614
error that can be emitted by ViSP classes.
Definition: vpException.h:60
const std::string & getStringMessage() const
Definition: vpException.cpp:67
int code
Contains the error code, see the errorCodeEnum table for details.
Definition: vpException.h:137
vpException()
forbid the empty constructor (protected)
Definition: vpException.h:146
int getCode() const
Definition: vpException.cpp:69
void setMessage(const char *format, va_list args)
Set the message container.
Definition: vpException.cpp:57
const char * getMessage() const
Definition: vpException.cpp:65
const char * what() const
Definition: vpException.cpp:71
std::string message
Contains an error message (can be empty)
Definition: vpException.h:140