ViSP  2.9.0
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 id, const char *format,...)
 
 vpServoException (const int id, const std::string &msg)
 
 vpServoException (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 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

Definition at line 65 of file vpServoException.h.

Member Enumeration Documentation

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.

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

vpServoException::vpServoException ( const int  id,
const char *  format,
  ... 
)
inline

Definition at line 86 of file vpServoException.h.

References vpException::setMessage().

vpServoException::vpServoException ( const int  id,
const std::string &  msg 
)
inline

Definition at line 94 of file vpServoException.h.

vpServoException::vpServoException ( const int  id)
inline

Definition at line 96 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 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.

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().