vpDisplayException Class Reference

#include <visp3/core/vpDisplayException.h>

Inheritance diagram for vpDisplayException:

Public Types
enum	errorDisplayCodeEnum {   notInitializedError , cannotOpenWindowError , connexionError , XWindowsError ,   GTKWindowsError , colorAllocError , depthNotSupportedError }
enum	generalExceptionEnum {   memoryAllocationError , memoryFreeError , functionNotImplementedError , ioError ,   cannotUseConstructorError , notImplementedError , divideByZeroError , dimensionError ,   fatalError , badValue , notInitialized }

Public Member Functions
	vpDisplayException (int id, const char *format,...)
	vpDisplayException (int id, const std::string &msg)
VP_EXPLICIT	vpDisplayException (int id)

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

Detailed Description

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

Definition at line 53 of file vpDisplayException.h.

Member Enumeration Documentation

errorDisplayCodeEnum

enum vpDisplayException::errorDisplayCodeEnum

Lists the possible error than can be emitted while calling vpDisplay member

Enumerator
notInitializedError	Display not initialized.
cannotOpenWindowError	Unable to open display window.
connexionError	Connection error.
XWindowsError	XWindow error.
GTKWindowsError	GTK error.
colorAllocError	Color allocation error.
depthNotSupportedError	Color depth not supported.

Definition at line 60 of file vpDisplayException.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.

Definition at line 62 of file vpException.h.

Constructor & Destructor Documentation

vpDisplayException() [1/3]

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

inline

Constructor.

Definition at line 75 of file vpDisplayException.h.

References vpException::setMessage().

vpDisplayException() [2/3]

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

inline

Constructor.

Definition at line 87 of file vpDisplayException.h.

vpDisplayException() [3/3]

VP_EXPLICIT vpDisplayException::vpDisplayException ( int  id )

inline

Constructor.

Definition at line 92 of file vpDisplayException.h.

Member Function Documentation

getCode()

int vpException::getCode ( ) const

inherited

Send the object code.

Examples

catchJsonArrayConversion.cpp, parallelPort.cpp, and ringLight.cpp.

Definition at line 69 of file vpException.cpp.

References vpException::code.

getMessage()

const char * vpException::getMessage ( ) const

inherited

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

Examples

mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, moveBiclops.cpp, parallelPort.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoFlirPtuIBVS.cpp, servoPololuPtuPoint2DJointVelocity.cpp, servoViper650FourPoints2DArtVelocityLs_cur.cpp, servoViper650FourPoints2DCamVelocityLs_cur-SR300.cpp, servoViper650FourPoints2DCamVelocityLs_cur.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850FourPoints2DArtVelocityLs_cur.cpp, servoViper850FourPoints2DArtVelocityLs_des.cpp, servoViper850FourPoints2DCamVelocityLs_cur.cpp, servoViper850FourPointsKinect.cpp, servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, servoViper850Point2DArtVelocity-jointAvoidance-large.cpp, servoViper850Point2DArtVelocity.cpp, servoViper850Point2DCamVelocity.cpp, servoViper850Point2DCamVelocityKalman.cpp, testConversion.cpp, testDisplays.cpp, testPololuPosition.cpp, testPololuVelocity.cpp, testReadImage.cpp, testRobotFlirPtu.cpp, testRobotViper650-frames.cpp, testRobotViper850-frames.cpp, testTrackDot.cpp, trackMeNurbs.cpp, tutorial-apriltag-detector-live-T265-realsense.cpp, tutorial-apriltag-detector-live-rgbd-realsense.cpp, tutorial-apriltag-detector-live-rgbd-structure-core.cpp, tutorial-apriltag-detector-live.cpp, tutorial-apriltag-detector.cpp, tutorial-barcode-detector.cpp, tutorial-draw-circle.cpp, tutorial-draw-cross.cpp, tutorial-draw-frame.cpp, tutorial-draw-line.cpp, tutorial-draw-point.cpp, tutorial-draw-rectangle.cpp, tutorial-draw-text.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-flir-ptu-ibvs.cpp, tutorial-image-display-scaled-auto.cpp, tutorial-image-display-scaled-manu.cpp, tutorial-image-display.cpp, tutorial-image-reader.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-webcam.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-points-live.cpp, tutorial-pose-from-points-realsense-T265.cpp, tutorial-pose-from-qrcode-image.cpp, and tutorial-video-reader.cpp.

Definition at line 65 of file vpException.cpp.

References vpException::message.

Referenced by vpTemplateTracker::trackPyr().

getStringMessage()

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

inherited

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

Examples

catchJsonArrayConversion.cpp, grabFlyCapture.cpp, parse-argv2.cpp, servoKinovaJacoCart.cpp, servoKinovaJacoJoint.cpp, testCrop.cpp, testCropAdvanced.cpp, testMatrixDeterminant.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, testPoseFeatures.cpp, testQbSoftHand.cpp, testSvd.cpp, testViper650.cpp, testViper850.cpp, testVirtuose.cpp, testVirtuoseAfma6.cpp, testVirtuoseHapticBox.cpp, testVirtuoseJointLimits.cpp, testVirtuosePeriodicFunction.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-realsense.cpp, tutorial-hsv-range-tuner.cpp, tutorial-hsv-segmentation.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd-structure-core.cpp, and tutorial-mb-generic-tracker-rgbd.cpp.

Definition at line 67 of file vpException.cpp.

References vpException::message.

Referenced by vpMomentCommon::updateAll().

setMessage()

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

protectedinherited

Set the message container.

Definition at line 57 of file vpException.cpp.

References vpException::message.

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

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

UniversalRobotsMoveToPosition.cpp, UniversalRobotsSavePosition.cpp, frankaGripper.cpp, frankaMoveToPosition.cpp, frankaSavePosition.cpp, getRealSense2Info.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, grabV4l2MultiCpp11Thread.cpp, servoAfma6AprilTagIBVS.cpp, servoAfma6AprilTagPBVS.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6MegaposePBVS.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoUniversalRobotsIBVS.cpp, servoUniversalRobotsPBVS.cpp, testAutoThreshold.cpp, testConnectedComponents.cpp, testContours.cpp, testFloodFill.cpp, testFrankaCartForceTorque-2.cpp, testFrankaCartForceTorque.cpp, testFrankaCartVelocity-2.cpp, testFrankaCartVelocity-3.cpp, testFrankaCartVelocity.cpp, testFrankaGetPose.cpp, testFrankaJointPosition.cpp, testFrankaJointTorque.cpp, testFrankaJointVelocity-2.cpp, testFrankaJointVelocity-3.cpp, testFrankaJointVelocity.cpp, testFrankaJointVelocityLimits.cpp, testHistogram.cpp, testImageFilter.cpp, testImgproc.cpp, testIoTools.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint-7.cpp, testKeyPoint.cpp, testMatrixConvolution.cpp, testMatrixInitialization.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_imu.cpp, testOccipitalStructure_Core_pcl.cpp, testPerformanceLUT.cpp, testPylonGrabber.cpp, testRealSense2_T265_images.cpp, testRealSense2_T265_images_odometry.cpp, testRealSense2_T265_images_odometry_async.cpp, testRealSense2_T265_imu.cpp, testRealSense2_T265_odometry.cpp, testRealSense2_T265_undistort.cpp, testUDPClient.cpp, testUDPServer.cpp, testUniversalRobotsCartPosition.cpp, testUniversalRobotsCartVelocity.cpp, testUniversalRobotsGetData.cpp, testUniversalRobotsJointPosition.cpp, testUniversalRobotsJointVelocity.cpp, tutorial-dnn-object-detection-live.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, tutorial-mb-generic-tracker-rgbd-structure-core.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, and tutorial-mb-generic-tracker-stereo.cpp.

Definition at line 71 of file vpException.cpp.

References vpException::message.

Referenced by vpKeyPoint::computePose(), vpMbDepthDenseTracker::loadConfigFile(), and vpMbDepthNormalTracker::loadConfigFile().

Member Data Documentation

code

int vpException::code

protectedinherited

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

Definition at line 137 of file vpException.h.

Referenced by vpException::getCode().

message

std::string vpException::message

protectedinherited

Contains an error message (can be empty)

Definition at line 140 of file vpException.h.

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