vpServoException Class Reference

#include <vpServoException.h>

Inheritance diagram for vpServoException:

Public Types
enum	errorServoCodeEnum { noFeatureError, noDofFree, notKilledProperly, servoError }
enum	generalExceptionEnum {   memoryAllocationError, memoryFreeError, functionNotImplementedError, ioError,   cannotUseConstructorError, notImplementedError, divideByZeroError, dimensionError,   fatalError, badValue, notInitialized }

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

Author

Eric Marchand (Eric..nosp@m.Marc.nosp@m.hand@.nosp@m.iris.nosp@m.a.fr) Irisa / Inria Rennes

Examples:

testFeature.cpp.

Definition at line 65 of file vpServoException.h.

Member Enumeration Documentation

enum vpServoException::errorServoCodeEnum

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

Enumerator
noFeatureError	Current or desired feature list is empty.
noDofFree	No degree of freedom is available to achieve the secondary task.
notKilledProperly	Task was not killed properly.
servoError	Other exception.

Definition at line 73 of file vpServoException.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

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

inline

Definition at line 86 of file vpServoException.h.

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

inline

Definition at line 88 of file vpServoException.h.

vpServoException::vpServoException ( const int  code )

inline

Definition at line 90 of file vpServoException.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.