vpSimulatorException Class Reference

#include <vpSimulatorException.h>

Inheritance diagram for vpSimulatorException:

Public Types
enum	errorSimulatorCodeEnum {   ioError, noFileNameError, notInitializedError, windowSizeNotInitializedError,   badInitializationError }
enum	generalExceptionEnum {   memoryAllocationError, memoryFreeError, functionNotImplementedError, ioError,   cannotUseConstructorError, notImplementedError, divideByZeroError, dimensionError,   fatalError, badValue, notInitialized }

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

Definition at line 74 of file vpSimulatorException.h.

Member Enumeration Documentation

enum vpSimulatorException::errorSimulatorCodeEnum

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

Enumerator
ioError
noFileNameError
notInitializedError
windowSizeNotInitializedError
badInitializationError

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

Constructor & Destructor Documentation

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

inline

Definition at line 91 of file vpSimulatorException.h.

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

inline

Definition at line 93 of file vpSimulatorException.h.

vpSimulatorException::vpSimulatorException ( const int  code )

inline

Definition at line 95 of file vpSimulatorException.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.