vpPoseException Class Reference

#include <vpPoseException.h>

Inheritance diagram for vpPoseException:

Public Types
enum	errorCodeEnum {   poseError, notInitializedError, notImplementedERR, outOfRangeError,   notEnoughPointError }
enum	generalExceptionEnum {   memoryAllocationError, memoryFreeError, functionNotImplementedError, ioError,   cannotUseConstructorError, notImplementedError, divideByZeroError, dimensionError,   fatalError, badValue, notInitialized }

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

Definition at line 68 of file vpPoseException.h.

Member Enumeration Documentation

enum vpPoseException::errorCodeEnum

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

Enumerator
poseError
notInitializedError	something is not initialized
notImplementedERR	function not implemented
outOfRangeError	index out of range
notEnoughPointError

Definition at line 75 of file vpPoseException.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 94 of file vpException.h.

Constructor & Destructor Documentation

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

inline

Definition at line 88 of file vpPoseException.h.

References vpException::setMessage().

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

inline

Definition at line 96 of file vpPoseException.h.

vpPoseException::vpPoseException ( const int  id )

inline

Definition at line 98 of file vpPoseException.h.

Member Function Documentation

int vpException::getCode ( void  )

inherited

send the object code

Examples:

parallelPort.cpp, and ringLight.cpp.

Definition at line 112 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, and tutorial-image-reader.cpp.

Definition at line 101 of file vpException.cpp.

References vpException::message.

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

inherited

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

Definition at line 106 of file vpException.cpp.

References vpException::message.

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

protectedinherited

Set the message container.

Definition at line 89 of file vpException.cpp.

References vpException::message.

Referenced by vpCalibrationException::vpCalibrationException(), vpDisplayException::vpDisplayException(), vpException::vpException(), vpFeatureException::vpFeatureException(), vpFrameGrabberException::vpFrameGrabberException(), vpImageException::vpImageException(), vpIoException::vpIoException(), vpMatrixException::vpMatrixException(), vpParallelPortException::vpParallelPortException(), 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.

Definition at line 123 of file vpException.cpp.

References vpException::message.

Member Data Documentation

int vpException::code

protectedinherited

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

Definition at line 81 of file vpException.h.

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

std::string vpException::message

protectedinherited

Contains an error message (can be empty)

Definition at line 84 of file vpException.h.

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