exceptions.h
/*
* Software License Agreement (BSD License)
*
* Point Cloud Library (PCL) - www.pointclouds.org
* Copyright (c) 2010-2011, Willow Garage, Inc.
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* * Neither the name of the copyright holder(s) nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*/
#ifndef PCL_EXCEPTIONS_H_
#define PCL_EXCEPTIONS_H_
#include <stdexcept>
#include <sstream>
#include <pcl/pcl_macros.h>
#include <boost/current_function.hpp>
/** PCL_THROW_EXCEPTION a helper macro to be used for throwing exceptions.
* This is an example on how to use:
* PCL_THROW_EXCEPTION(IOException,
* "encountered an error while opening " << filename << " PCD file");
*/
#define PCL_THROW_EXCEPTION(ExceptionName, message) \
{ \
std::ostringstream s; \
s << message; \
s.flush (); \
throw ExceptionName(s.str(), __FILE__, BOOST_CURRENT_FUNCTION, __LINE__); \
}
namespace pcl
{
/** \class PCLException
* \brief A base class for all pcl exceptions which inherits from std::runtime_error
* \author Eitan Marder-Eppstein, Suat Gedikli, Nizar Sallem
*/
class PCLException : public std::runtime_error
{
public:
PCLException (const std::string& error_description,
const std::string& file_name = "",
const std::string& function_name = "" ,
unsigned line_number = 0) throw ()
: std::runtime_error (error_description)
, file_name_ (file_name)
, function_name_ (function_name)
, message_ (error_description)
, line_number_ (line_number)
{
message_ = detailedMessage ();
}
virtual ~PCLException () throw ()
{}
const std::string&
getFileName () const throw ()
{
return (file_name_);
}
const std::string&
getFunctionName () const throw ()
{
return (function_name_);
}
unsigned
getLineNumber () const throw ()
{
return (line_number_);
}
std::string
detailedMessage () const throw ()
{
std::stringstream sstream;
if (function_name_ != "")
sstream << function_name_ << " ";
if (file_name_ != "")
{
sstream << "in " << file_name_ << " ";
if (line_number_ != 0)
sstream << "@ " << line_number_ << " ";
}
sstream << ": " << what ();
return (sstream.str ());
}
char const*
what () const throw ()
{
return (message_.c_str ());
}
protected:
std::string file_name_;
std::string function_name_;
std::string message_;
unsigned line_number_;
} ;
/** \class InvalidConversionException
* \brief An exception that is thrown when a PCLPointCloud2 message cannot be converted into a PCL type
*/
class InvalidConversionException : public PCLException
{
public:
InvalidConversionException (const std::string& error_description,
const std::string& file_name = "",
const std::string& function_name = "" ,
unsigned line_number = 0) throw ()
: pcl::PCLException (error_description, file_name, function_name, line_number) { }
} ;
/** \class IsNotDenseException
* \brief An exception that is thrown when a PointCloud is not dense but is attemped to be used as dense
*/
class IsNotDenseException : public PCLException
{
public:
IsNotDenseException (const std::string& error_description,
const std::string& file_name = "",
const std::string& function_name = "" ,
unsigned line_number = 0) throw ()
: pcl::PCLException (error_description, file_name, function_name, line_number) { }
} ;
/** \class InvalidSACModelTypeException
* \brief An exception that is thrown when a sample consensus model doesn't
* have the correct number of samples defined in model_types.h
*/
class InvalidSACModelTypeException : public PCLException
{
public:
InvalidSACModelTypeException (const std::string& error_description,
const std::string& file_name = "",
const std::string& function_name = "" ,
unsigned line_number = 0) throw ()
: pcl::PCLException (error_description, file_name, function_name, line_number) { }
} ;
/** \class IOException
* \brief An exception that is thrown during an IO error (typical read/write errors)
*/
class IOException : public PCLException
{
public:
IOException (const std::string& error_description,
const std::string& file_name = "",
const std::string& function_name = "" ,
unsigned line_number = 0) throw ()
: pcl::PCLException (error_description, file_name, function_name, line_number) { }
} ;
/** \class InitFailedException
* \brief An exception thrown when init can not be performed should be used in all the
* PCLBase class inheritants.
*/
class InitFailedException : public PCLException
{
public:
InitFailedException (const std::string& error_description = "",
const std::string& file_name = "",
const std::string& function_name = "" ,
unsigned line_number = 0) throw ()
: pcl::PCLException (error_description, file_name, function_name, line_number) { }
} ;
/** \class UnorganizedPointCloudException
* \brief An exception that is thrown when an organized point cloud is needed
* but not provided.
*/
class UnorganizedPointCloudException : public PCLException
{
public:
UnorganizedPointCloudException (const std::string& error_description,
const std::string& file_name = "",
const std::string& function_name = "" ,
unsigned line_number = 0) throw ()
: pcl::PCLException (error_description, file_name, function_name, line_number) { }
} ;
/** \class KernelWidthTooSmallException
* \brief An exception that is thrown when the kernel size is too small
*/
class KernelWidthTooSmallException : public PCLException
{
public:
KernelWidthTooSmallException (const std::string& error_description,
const std::string& file_name = "",
const std::string& function_name = "" ,
unsigned line_number = 0) throw ()
: pcl::PCLException (error_description, file_name, function_name, line_number) { }
} ;
class UnhandledPointTypeException : public PCLException
{
public:
UnhandledPointTypeException (const std::string& error_description,
const std::string& file_name = "",
const std::string& function_name = "" ,
unsigned line_number = 0) throw ()
: pcl::PCLException (error_description, file_name, function_name, line_number) { }
};
class ComputeFailedException : public PCLException
{
public:
ComputeFailedException (const std::string& error_description,
const std::string& file_name = "",
const std::string& function_name = "" ,
unsigned line_number = 0) throw ()
: pcl::PCLException (error_description, file_name, function_name, line_number) { }
};
/** \class BadArgumentException
* \brief An exception that is thrown when the argments number or type is wrong/unhandled.
*/
class BadArgumentException : public PCLException
{
public:
BadArgumentException (const std::string& error_description,
const std::string& file_name = "",
const std::string& function_name = "" ,
unsigned line_number = 0) throw ()
: pcl::PCLException (error_description, file_name, function_name, line_number) { }
};
}
#endif
pcl::InvalidSACModelTypeException
An exception that is thrown when a sample consensus model doesn&#39;t have the correct number of samples ...
Definition: exceptions.h:166
pcl::PCLException::getFunctionName
const std::string & getFunctionName() const
Definition: exceptions.h:92
pcl::KernelWidthTooSmallException::KernelWidthTooSmallException
KernelWidthTooSmallException(const std::string &error_description, const std::string &file_name="", const std::string &function_name="", unsigned line_number=0)
Definition: exceptions.h:227
pcl::IsNotDenseException
An exception that is thrown when a PointCloud is not dense but is attemped to be used as dense...
Definition: exceptions.h:151
pcl::PCLException
A base class for all pcl exceptions which inherits from std::runtime_error.
Definition: exceptions.h:65
pcl::PCLException::~PCLException
virtual ~PCLException()
Definition: exceptions.h:82
pcl::PCLException::line_number_
unsigned line_number_
Definition: exceptions.h:131
pcl::UnhandledPointTypeException
Definition: exceptions.h:234
pcl
Definition: cloud_iterator.h:46
pcl::UnorganizedPointCloudException::UnorganizedPointCloudException
UnorganizedPointCloudException(const std::string &error_description, const std::string &file_name="", const std::string &function_name="", unsigned line_number=0)
Definition: exceptions.h:213
pcl::BadArgumentException
An exception that is thrown when the argments number or type is wrong/unhandled.
Definition: exceptions.h:257
std
Definition: multi_grid_octree_data.hpp:45
pcl::InvalidSACModelTypeException::InvalidSACModelTypeException
InvalidSACModelTypeException(const std::string &error_description, const std::string &file_name="", const std::string &function_name="", unsigned line_number=0)
Definition: exceptions.h:170
pcl::PCLException::file_name_
std::string file_name_
Definition: exceptions.h:128
pcl::KernelWidthTooSmallException
An exception that is thrown when the kernel size is too small.
Definition: exceptions.h:223
pcl::PCLException::getFileName
const std::string & getFileName() const
Definition: exceptions.h:86
pcl::PCLException::what
char const * what() const
Definition: exceptions.h:122
pcl::InitFailedException
An exception thrown when init can not be performed should be used in all the PCLBase class inheritant...
Definition: exceptions.h:195
pcl::UnhandledPointTypeException::UnhandledPointTypeException
UnhandledPointTypeException(const std::string &error_description, const std::string &file_name="", const std::string &function_name="", unsigned line_number=0)
Definition: exceptions.h:237
pcl::ComputeFailedException::ComputeFailedException
ComputeFailedException(const std::string &error_description, const std::string &file_name="", const std::string &function_name="", unsigned line_number=0)
Definition: exceptions.h:247
pcl::IOException
An exception that is thrown during an IO error (typical read/write errors)
Definition: exceptions.h:180
pcl::ComputeFailedException
Definition: exceptions.h:244
pcl::InvalidConversionException::InvalidConversionException
InvalidConversionException(const std::string &error_description, const std::string &file_name="", const std::string &function_name="", unsigned line_number=0)
Definition: exceptions.h:141
pcl::PCLException::PCLException
PCLException(const std::string &error_description, const std::string &file_name="", const std::string &function_name="", unsigned line_number=0)
Definition: exceptions.h:69
pcl::UnorganizedPointCloudException
An exception that is thrown when an organized point cloud is needed but not provided.
Definition: exceptions.h:209
pcl::InvalidConversionException
An exception that is thrown when a PCLPointCloud2 message cannot be converted into a PCL type...
Definition: exceptions.h:137
pcl::PCLException::getLineNumber
unsigned getLineNumber() const
Definition: exceptions.h:98
pcl::PCLException::message_
std::string message_
Definition: exceptions.h:130
pcl::IsNotDenseException::IsNotDenseException
IsNotDenseException(const std::string &error_description, const std::string &file_name="", const std::string &function_name="", unsigned line_number=0)
Definition: exceptions.h:155
pcl::IOException::IOException
IOException(const std::string &error_description, const std::string &file_name="", const std::string &function_name="", unsigned line_number=0)
Definition: exceptions.h:184
pcl::InitFailedException::InitFailedException
InitFailedException(const std::string &error_description="", const std::string &file_name="", const std::string &function_name="", unsigned line_number=0)
Definition: exceptions.h:198
pcl::PCLException::detailedMessage
std::string detailedMessage() const
Definition: exceptions.h:104
pcl::BadArgumentException::BadArgumentException
BadArgumentException(const std::string &error_description, const std::string &file_name="", const std::string &function_name="", unsigned line_number=0)
Definition: exceptions.h:260
pcl::PCLException::function_name_
std::string function_name_
Definition: exceptions.h:129