Visual Servoing Platform  version 3.0.0
vpFrameGrabberException Class Reference

#include <visp3/core/vpFrameGrabberException.h>

+ Inheritance diagram for vpFrameGrabberException:

Public Types

enum  errorFrameGrabberCodeEnum { settingError, initializationError, otherError }
 
enum  generalExceptionEnum {
  memoryAllocationError, memoryFreeError, functionNotImplementedError, ioError,
  cannotUseConstructorError, notImplementedError, divideByZeroError, dimensionError,
  fatalError, badValue, notInitialized
}
 

Public Member Functions

 vpFrameGrabberException (const int id, const char *format,...)
 
 vpFrameGrabberException (const int id, const std::string &msg)
 
 vpFrameGrabberException (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 vpFrameGrabber class and its derivates.

Definition at line 65 of file vpFrameGrabberException.h.

Member Enumeration Documentation

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

Enumerator
settingError 
initializationError 
otherError 

Definition at line 72 of file vpFrameGrabberException.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 91 of file vpException.h.

Constructor & Destructor Documentation

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

Definition at line 80 of file vpFrameGrabberException.h.

References vpException::setMessage().

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

Definition at line 88 of file vpFrameGrabberException.h.

vpFrameGrabberException::vpFrameGrabberException ( const int  id)
inline

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

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