Visual Servoing Platform  version 3.1.0
vpPoseException Class Reference

#include <visp3/vision/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)
 
const char * what () const throw ()
 
Inherited functionalities from vpException
int getCode (void)
 
const std::string & getStringMessage (void) const
 
const char * getMessage (void) const
 

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

◆ 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.

◆ generalExceptionEnum

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 87 of file vpException.h.

Constructor & Destructor Documentation

◆ vpPoseException() [1/3]

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

Definition at line 87 of file vpPoseException.h.

References vpException::setMessage().

◆ vpPoseException() [2/3]

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

Definition at line 95 of file vpPoseException.h.

◆ vpPoseException() [3/3]

vpPoseException::vpPoseException ( const int  id)
inlineexplicit

Definition at line 96 of file vpPoseException.h.

Member Function Documentation

◆ getCode()

int vpException::getCode ( void  )
inherited

Send the object code.

Examples:
parallelPort.cpp, and ringLight.cpp.

Definition at line 94 of file vpException.cpp.

References vpException::code.

◆ getMessage()

◆ getStringMessage()

◆ setMessage()

◆ what()

Member Data Documentation

◆ code

int vpException::code
protectedinherited

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

Definition at line 75 of file vpException.h.

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

◆ message

std::string vpException::message
protectedinherited

Contains an error message (can be empty)

Definition at line 78 of file vpException.h.

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