Point Cloud Library (PCL)  1.7.1
openni_exception.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011 Willow Garage, Inc.
5  *
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * * Neither the name of the copyright holder(s) nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  *
35  */
36 
37 #include <pcl/pcl_config.h>
38 #ifdef HAVE_OPENNI
39 
40 #ifndef __OPENNI_EXCEPTION__
41 #define __OPENNI_EXCEPTION__
42 
43 #include <cstdarg>
44 #include <cstdio>
45 #include <exception>
46 #include <string>
47 //#include <pcl/pcl_macros.h> <-- because current header is included in NVCC-compiled code and contains <Eigen/Core>. Consider <pcl/pcl_exports.h>
48 
49 
50 //fom <pcl/pcl_macros.h>
51 #if defined _WIN32 && defined _MSC_VER && !defined __PRETTY_FUNCTION__
52  #define __PRETTY_FUNCTION__ __FUNCTION__
53 #endif
54 
55 
56 #define THROW_OPENNI_EXCEPTION(format,...) throwOpenNIException( __PRETTY_FUNCTION__, __FILE__, __LINE__, format , ##__VA_ARGS__ )
57 
58 
59 namespace openni_wrapper
60 {
61 
62  /**
63  * @brief General exception class
64  * @author Suat Gedikli
65  * @date 02.january 2011
66  * @ingroup io
67  */
68  class OpenNIException : public std::exception
69  {
70  public:
71  /**
72  * @brief Constructor
73  * @note use the MACRO THROW_OPENNI_EXCEPTION, that takes care about the parameters function_name, file_name and line_number
74  * @param[in] function_name the function in which this exception was created.
75  * @param[in] file_name the file name in which this exception was created.
76  * @param[in] line_number the line number where this exception was created.
77  * @param[in] message the message of the exception
78  */
79  OpenNIException (const std::string& function_name, const std::string& file_name, unsigned line_number, const std::string& message) throw ();
80 
81  /**
82  * @brief virtual Destructor that never throws an exception
83  */
84  virtual ~OpenNIException () throw ();
85 
86  /**
87  * @brief Assignment operator to allow copying the message of another exception variable.
88  * @param[in] exception left hand side
89  * @return
90  */
91  OpenNIException & operator= (const OpenNIException& exception) throw ();
92 
93  /**
94  * @brief virtual method, derived from std::exception
95  * @return the message of the exception.
96  */
97  virtual const char* what () const throw ();
98 
99  /**
100  * @return the function name in which the exception was created.
101  */
102  const std::string& getFunctionName () const throw ();
103 
104  /**
105  * @return the filename in which the exception was created.
106  */
107  const std::string& getFileName () const throw ();
108 
109  /**
110  * @return the line number where the exception was created.
111  */
112  unsigned getLineNumber () const throw ();
113  protected:
114  std::string function_name_;
115  std::string file_name_;
116  unsigned line_number_;
117  std::string message_;
118  std::string message_long_;
119  } ;
120 
121  /**
122  * @brief inline function used by the macro THROW_OPENNI_EXCEPTION to create an instance of OpenNIException with correct values for function, file and line_number
123  * @param[in] function_name the function name. Will be filled in by the macro THROW_OPENNI_EXCEPTION
124  * @param[in] file_name the file name. Will be filled in by the macro THROW_OPENNI_EXCEPTION
125  * @param[in] line_number the line number. Will be filled in by the macro THROW_OPENNI_EXCEPTION
126  * @param[in] format the printf-style format string
127  * @param[in] ... optional arguments for the printf style format.
128  */
129  inline void
130  throwOpenNIException (const char* function_name, const char* file_name, unsigned line_number, const char* format, ...)
131  {
132  static char msg[1024];
133  va_list args;
134  va_start (args, format);
135  vsprintf (msg, format, args);
136  throw OpenNIException (function_name, file_name, line_number, msg);
137  }
138 } // namespace openni_camera
139 #endif
140 #endif