vpImageException Class Reference

#include <visp3/core/vpImageException.h>

Inheritance diagram for vpImageException:

Public Types
enum	errorImageCodeEnum {   ioError, noFileNameError, notInitializedError, incorrectInitializationError,   notInTheImage }
enum	generalExceptionEnum {   memoryAllocationError, memoryFreeError, functionNotImplementedError, ioError,   cannotUseConstructorError, notImplementedError, divideByZeroError, dimensionError,   fatalError, badValue, notInitialized }

Public Member Functions
	vpImageException (const int id, const char *format,...)
	vpImageException (const int id, const std::string &msg)
	vpImageException (const int id)
int	getCode (void)
const std::string &	getStringMessage (void)
const char *	getMessage (void)
const char *	what () const throw ()

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 vpImage class and its derivates.

Examples:

testIoPPM.cpp.

Definition at line 68 of file vpImageException.h.

Member Enumeration Documentation

enum vpImageException::errorImageCodeEnum

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

Enumerator
ioError
noFileNameError
notInitializedError
incorrectInitializationError
notInTheImage

Definition at line 75 of file vpImageException.h.

enum vpException::generalExceptionEnum

inherited

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

vpImageException::vpImageException ( const int  id, const char *  format,   ...  )

inline

Definition at line 85 of file vpImageException.h.

References vpException::setMessage().

vpImageException::vpImageException ( const int  id, const std::string &  msg  )

inline

Definition at line 93 of file vpImageException.h.

vpImageException::vpImageException ( const int  id )

inline

Definition at line 95 of file vpImageException.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 char * vpException::getMessage ( void  )

inherited

send a pointer on the array of char related to the error string. Cannot be NULL.

Examples:

fernClassifier.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, trackMeNurbs.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-image-reader.cpp, and tutorial-video-reader.cpp.

Definition at line 97 of file vpException.cpp.

References vpException::message.

Referenced by vpTemplateTracker::trackPyr().

const std::string & vpException::getStringMessage ( void  )

inherited

send a reference (constant) related the error message (can be empty)

Definition at line 102 of file vpException.cpp.

References vpException::message.

void vpException::setMessage ( const char *  format, va_list  args  )

protectedinherited

Set the message container.

Definition at line 85 of file vpException.cpp.

References vpException::message.

Referenced by vpCalibrationException::vpCalibrationException(), vpDisplayException::vpDisplayException(), vpException::vpException(), vpFeatureException::vpFeatureException(), vpFrameGrabberException::vpFrameGrabberException(), vpImageException(), vpIoException::vpIoException(), vpMatrixException::vpMatrixException(), vpParallelPortException::vpParallelPortException(), vpPoseException::vpPoseException(), vpRobotException::vpRobotException(), vpServoException::vpServoException(), vpSimulatorException::vpSimulatorException(), and vpTrackingException::vpTrackingException().

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:

testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint-7.cpp, testKeyPoint.cpp, and testPerformanceLUT.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().