vpRobotException Class Reference

#include <visp3/robot/vpRobotException.h>

Inheritance diagram for vpRobotException:

Public Types
enum	errorRobotCodeEnum {   constructionError, uniqueRobotError, wrongStateError, stateModificationError,   communicationError, lowLevelError, readingParametersError, notInitializedError,   notImplementedError, positionOutOfRangeError }
enum	generalExceptionEnum {   memoryAllocationError, memoryFreeError, functionNotImplementedError, ioError,   cannotUseConstructorError, notImplementedError, divideByZeroError, dimensionError,   fatalError, badValue, notInitialized }

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

Definition at line 67 of file vpRobotException.h.

Member Enumeration Documentation

enum vpRobotException::errorRobotCodeEnum

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

Enumerator
constructionError	Erreur lancee par le constructor.
uniqueRobotError	Erreur lancee lors de la construction d'un objet CRobot correspondant a un robot reel si l'objet de la classe en question doit etre unique.
wrongStateError	Erreur lancee par les fonctions de commande si le robot n'est pas dans le bon etat au moment du passage d'ordre.
stateModificationError	Erreur lancee par les fonctions de changement d'etat si le changement demandee n'est pas possible.
communicationError	Erreur generee lors d'un retour non nulle d'une fonction de communication de la lib Afma6.
lowLevelError	Erreur lancee apres un appel a une fonction de la lib bas-niveau de control de l'afma6 ayant renvoye une erreur.
readingParametersError	Erreur lancee par la fonction de parsing des parametres du robot, si le fichier donne en entree n'est pas valide.
notInitializedError	Erreur lancee par les methodes d'une classe qui necessite un appel a une fonction d'initialisation apres la construction si l'init n'a pas ete fait.
notImplementedError	Erreur lancee par les fonctions decrites dans lAPI mais pas completement implementee. Dans ce cas, la fonction affiche simplement un message d'erreur avant de sortir par le 'throw'.
positionOutOfRangeError	Position is out of range.

Definition at line 74 of file vpRobotException.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

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

inline

Definition at line 124 of file vpRobotException.h.

References vpException::setMessage().

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

inline

Definition at line 132 of file vpRobotException.h.

vpRobotException::vpRobotException ( const int  id )

inline

Definition at line 136 of file vpRobotException.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::vpImageException(), vpIoException::vpIoException(), vpMatrixException::vpMatrixException(), vpParallelPortException::vpParallelPortException(), vpPoseException::vpPoseException(), 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().