ViSP  2.8.0
vpImageException Class Reference

#include <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 code, const char *msg)
 
 vpImageException (const int code, const std::string &msg)
 
 vpImageException (const int code)
 
int getCode (void)
 
const std::string & getStringMessage (void)
 
const char * getMessage (void)
 
const char * what () const throw ()
 

Detailed Description

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

Examples:
imageDiskRW.cpp, testIoPGM.cpp, and testIoPPM.cpp.

Definition at line 74 of file vpImageException.h.

Member Enumeration Documentation

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

Enumerator
ioError 
noFileNameError 
notInitializedError 
incorrectInitializationError 
notInTheImage 

Definition at line 81 of file vpImageException.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 93 of file vpException.h.

Constructor & Destructor Documentation

vpImageException::vpImageException ( const int  code,
const char *  msg 
)
inline

Definition at line 91 of file vpImageException.h.

vpImageException::vpImageException ( const int  code,
const std::string &  msg 
)
inline

Definition at line 93 of file vpImageException.h.

vpImageException::vpImageException ( const int  code)
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 111 of file vpException.cpp.

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, and grabV4l2.cpp.

Definition at line 100 of file vpException.cpp.

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

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

Definition at line 105 of file vpException.cpp.

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.

Definition at line 122 of file vpException.cpp.