Visual Servoing Platform  version 3.0.1
vpIoException Class Reference

#include <vpIoException.h>

+ Inheritance diagram for vpIoException:

Public Types

enum  error { invalidDirectoryName, cantCreateDirectory, cantGetUserName, cantGetenv }
 
enum  generalExceptionEnum {
  memoryAllocationError, memoryFreeError, functionNotImplementedError, ioError,
  cannotUseConstructorError, notImplementedError, divideByZeroError, dimensionError,
  fatalError, badValue, notInitialized
}
 

Public Member Functions

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

Definition at line 68 of file vpIoException.h.

Member Enumeration Documentation

◆ error

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

Enumerator
invalidDirectoryName 
cantCreateDirectory 

Directory name is invalid.

cantGetUserName 

Unable to create a directory.

cantGetenv 

User name is not available.

Cannot get environment variable value.

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

Constructor & Destructor Documentation

◆ vpIoException() [1/3]

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

Definition at line 84 of file vpIoException.h.

References vpException::setMessage().

◆ vpIoException() [2/3]

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

Definition at line 92 of file vpIoException.h.

◆ vpIoException() [3/3]

vpIoException::vpIoException ( const int  id)
inline

Definition at line 94 of file vpIoException.h.

Member Function Documentation

◆ getCode()

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.

◆ getMessage()

◆ getStringMessage()

const std::string & vpException::getStringMessage ( void  ) const
inherited

◆ setMessage()

◆ what()

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:
grabV4l2MultiCpp11Thread.cpp, testHistogram.cpp, testImageFilter.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint-7.cpp, testKeyPoint.cpp, testPerformanceLUT.cpp, and testRealSense.cpp.

Definition at line 119 of file vpException.cpp.

References vpException::message.

Referenced by vpKeyPoint::computePose().

Member Data Documentation

◆ code

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

◆ message

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