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

Inherited functionalities from vpException
int	getCode () const
const std::string &	getStringMessage () const
const char *	getMessage () const
const char *	what () const VP_NOEXCEPT VP_OVERRIDE
int	code
std::string	message
void	setMessage (const char *format, va_list args)

Detailed Description

Error that can be emitted by the vpServo class and its derivatives.

Definition at line 53 of file vpServoException.h.

Member Enumeration Documentation

errorServoCodeEnum

enum vpServoException::errorServoCodeEnum

Lists the possible error than can be emitted 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 60 of file vpServoException.h.

generalExceptionEnum

enum vpException::generalExceptionEnum

inherited

Enumerator
memoryAllocationError	Memory allocation error.
memoryFreeError	Memory free error.
functionNotImplementedError	Function not implemented.
ioError	I/O error.
cannotUseConstructorError	constructor error
notImplementedError	Not implemented.
divideByZeroError	Division by zero.
dimensionError	Bad dimension.
fatalError	Fatal error.
badValue	Used to indicate that a value is not in the allowed range.
notInitialized	Used to indicate that a parameter is not initialized.

Examples

catchJsonArrayConversion.cpp.

Definition at line 62 of file vpException.h.

Constructor & Destructor Documentation

vpServoException() [1/3]

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

inline

Constructor.

Definition at line 76 of file vpServoException.h.

References vpException::code, and vpException::setMessage().

vpServoException() [2/3]

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

inline

Constructor.

Definition at line 88 of file vpServoException.h.

References vpException::vpException().

vpServoException() [3/3]

VP_EXPLICIT vpServoException::vpServoException ( int id )

inline

Constructor.

Definition at line 93 of file vpServoException.h.

References vpException::vpException().

Member Function Documentation

getCode()

int vpException::getCode ( ) const

inherited

Send the object code.

Examples

catchJsonArrayConversion.cpp.

Definition at line 69 of file vpException.cpp.

References code.

getMessage()

const char * vpException::getMessage ( ) const

inherited

Send a pointer on the array of char related to the error string. Cannot be nullptr.

Definition at line 65 of file vpException.cpp.

References message.

getStringMessage()

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

inherited

Send a reference (constant) related the error message (can be empty).

Examples

catchJsonArrayConversion.cpp.

Definition at line 67 of file vpException.cpp.

References message.

setMessage()

void vpException::setMessage ( const char * format, va_list args )

protectedinherited

Set the message container.

Definition at line 57 of file vpException.cpp.

References message.

Referenced by vpCalibrationException::vpCalibrationException(), vpDisplayException::vpDisplayException(), vpException(), vpException(), vpFeatureException::vpFeatureException(), vpFrameGrabberException::vpFrameGrabberException(), vpImageException::vpImageException(), vpIoException::vpIoException(), vpMatrixException::vpMatrixException(), vpParallelPortException::vpParallelPortException(), vpPoseException::vpPoseException(), vpRobotException::vpRobotException(), vpServoException::vpServoException(), vpSimulatorException::vpSimulatorException(), and vpTrackingException::vpTrackingException().

what()

const char * vpException::what ( ) const

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 72 of file vpException.cpp.

References message.

Member Data Documentation

code

int vpException::code

protectedinherited

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

Definition at line 141 of file vpException.h.

Referenced by getCode(), vpCalibrationException::vpCalibrationException(), vpDisplayException::vpDisplayException(), vpException(), vpException(), vpException(), vpException(), vpException(), vpFeatureException::vpFeatureException(), vpFrameGrabberException::vpFrameGrabberException(), vpImageException::vpImageException(), vpIoException::vpIoException(), vpMatrixException::vpMatrixException(), vpParallelPortException::vpParallelPortException(), vpPoseException::vpPoseException(), vpRobotException::vpRobotException(), vpServoException::vpServoException(), vpSimulatorException::vpSimulatorException(), and vpTrackingException::vpTrackingException().

message

std::string vpException::message

protectedinherited

Contains an error message (can be empty).

Definition at line 144 of file vpException.h.

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