Visual Servoing Platform  version 3.0.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
vpFeatureException Class Reference

#include <visp3/visual_features/vpFeatureException.h>

+ Inheritance diagram for vpFeatureException:

Public Types

enum  errorFeatureCodeEnum { badErrorVectorError, sizeMismatchError, notInitializedError, badInitializationError }
 
enum  generalExceptionEnum {
  memoryAllocationError, memoryFreeError, functionNotImplementedError, ioError,
  cannotUseConstructorError, notImplementedError, divideByZeroError, dimensionError,
  fatalError, badValue, notInitialized
}
 

Public Member Functions

 vpFeatureException (const int id, const char *format,...)
 
 vpFeatureException (const int id, const std::string &msg)
 
 vpFeatureException (const int id)
 
const char * what () const throw ()
 
Inherited functionalities from vpException
int getCode (void)
 
const std::string & getStringMessage (void) const
 
const char * getMessage (void) const
 

Protected Member Functions

void setMessage (const char *format, va_list args)
 

Protected Attributes

int code
 
std::string message
 

Detailed Description

Error that can be emited by the vpBasicFeature class and its derivates.

Definition at line 67 of file vpFeatureException.h.

Member Enumeration Documentation

Lists the possible error than can be emmited while calling vpFeature member.

Enumerator
badErrorVectorError 

feature list or desired feature list is empty

sizeMismatchError 
notInitializedError 
badInitializationError 

Definition at line 74 of file vpFeatureException.h.

Enumerator
memoryAllocationError 
memoryFreeError 
functionNotImplementedError 
ioError 
cannotUseConstructorError 
notImplementedError 
divideByZeroError 
dimensionError 
fatalError 
badValue 

Used to indicate that a value is not in the allowed range.

notInitialized 

Used to indicate that a parameter is not initialized.

Definition at line 91 of file vpException.h.

Constructor & Destructor Documentation

vpFeatureException::vpFeatureException ( const int  id,
const char *  format,
  ... 
)
inline

Definition at line 84 of file vpFeatureException.h.

References vpException::setMessage().

vpFeatureException::vpFeatureException ( const int  id,
const std::string &  msg 
)
inline

Definition at line 92 of file vpFeatureException.h.

vpFeatureException::vpFeatureException ( const int  id)
inline

Definition at line 94 of file vpFeatureException.h.

Member Function Documentation

int vpException::getCode ( void  )
inherited

Send the object code.

Examples:
parallelPort.cpp, and ringLight.cpp.

Definition at line 108 of file vpException.cpp.

References vpException::code.

const std::string & vpException::getStringMessage ( void  ) const
inherited
const char * vpException::what ( ) const
throw (
)
inherited

Overloading of the what() method of std::exception to return the vpException message.

Returns
pointer on the array of char related to the error string.
Examples:
grabV4l2MultiCpp11Thread.cpp, testHistogram.cpp, testImageFilter.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint-7.cpp, testKeyPoint.cpp, testPerformanceLUT.cpp, and testRealSense.cpp.

Definition at line 119 of file vpException.cpp.

References vpException::message.

Referenced by vpKeyPoint::computePose().

Member Data Documentation

int vpException::code
protectedinherited

Contains the error code, see the errorCodeEnum table for details.

Definition at line 78 of file vpException.h.

Referenced by vpException::getCode(), and vpSimulatorException::vpSimulatorException().

std::string vpException::message
protectedinherited

Contains an error message (can be empty)

Definition at line 81 of file vpException.h.

Referenced by vpException::getMessage(), vpException::getStringMessage(), vpException::setMessage(), and vpException::what().