vpIoException Class Reference

#include <vpIoException.h>

Inheritance diagram for vpIoException:

Public Types
enum	error { invalidDirectoryName, cantCreateDirectory, cantGetUserName, cantGetenv }
enum	generalExceptionEnum {   memoryAllocationError, memoryFreeError, functionNotImplementedError, ioError,   cannotUseConstructorError, notImplementedError, divideByZeroError, dimensionError,   fatalError, badValue, notInitialized }

Public Member Functions
	vpIoException (const int code, const char *msg)
	vpIoException (const int code, const std::string &msg)
	vpIoException (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 vpIoTools class and its derivates.

Definition at line 72 of file vpIoException.h.

Member Enumeration Documentation

enum vpIoException::error

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

Enumerator
invalidDirectoryName
cantCreateDirectory	Directory name is invalid.
cantGetUserName	Unable to create a directory.
cantGetenv	User name is not available. Cannot get environment variable value.

Definition at line 79 of file vpIoException.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 92 of file vpException.h.

Constructor & Destructor Documentation

vpIoException::vpIoException ( const int  code, const char *  msg  )

inline

Definition at line 88 of file vpIoException.h.

vpIoException::vpIoException ( const int  code, const std::string &  msg  )

inline

Definition at line 90 of file vpIoException.h.

vpIoException::vpIoException ( const int  code )

inline

Definition at line 92 of file vpIoException.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.