vpException Class Reference

#include <vpException.h>

Inheritance diagram for vpException:

Public Types
enum	generalExceptionEnum {   memoryAllocationError , memoryFreeError , functionNotImplementedError , ioError ,   cannotUseConstructorError , notImplementedError , divideByZeroError , dimensionError ,   fatalError , badValue , notInitialized }

Public Member Functions
	vpException (int code, const char *format, va_list args)
	vpException (int code, const char *format,...)
	vpException (int code, const std::string &msg)
VP_EXPLICIT	vpException (int code)

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

Detailed Description

error that can be emitted by ViSP classes.

This class inherits from the standard std::exception contained in the C++ STL. It is therefore possible to catch vpException with any other derivative of std::exception in the same catch.

Examples

AROgre.cpp, AROgreBasic.cpp, BSpline.cpp, HelloWorldOgre.cpp, HelloWorldOgreAdvanced.cpp, SickLDMRS-Acq.cpp, SickLDMRS-Process.cpp, UniversalRobotsMoveToPosition.cpp, UniversalRobotsSavePosition.cpp, catchJsonArrayConversion.cpp, catchJsonCamera.cpp, displayD3D.cpp, displayGTK.cpp, displayOpenCV.cpp, displaySequence.cpp, displayX.cpp, displayXMulti.cpp, exponentialMap.cpp, frankaGripper.cpp, frankaMoveToPosition.cpp, frankaSavePosition.cpp, getRealSense2Info.cpp, grab1394CMU.cpp, grab1394Two.cpp, grabDirectShow.cpp, grabDirectShowMulti.cpp, grabDisk.cpp, grabDiskFloat.cpp, grabFlyCapture.cpp, grabRealSense2.cpp, grabRealSense2_T265.cpp, grabV4l2.cpp, grabV4l2MultiCpp11Thread.cpp, histogram.cpp, homographyHLM2DObject.cpp, homographyHLM3DObject.cpp, homographyHartleyDLT2DObject.cpp, homographyRansac2DObject.cpp, imageDiskRW.cpp, imageSequenceReader.cpp, keyboardControlBebop2.cpp, kinectAcquisition.cpp, manDisplay.cpp, manGeometricFeatures.cpp, manGrab1394.cpp, manGrabDirectShow.cpp, manGrabDisk.cpp, manGrabV4l2.cpp, manServo4PointsDisplay.cpp, manServoMomentsSimple.cpp, manSimu4Dots.cpp, manSimu4Points.cpp, mbot-apriltag-2D-half-vs.cpp, mbot-apriltag-ibvs.cpp, mbot-apriltag-pbvs.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, moveBiclops.cpp, movePioneer.cpp, movePtu46.cpp, parallelPort.cpp, parse-argv1.cpp, parse-argv2.cpp, perfMatrixMultiplication.cpp, photometricMappingVisualServoing.cpp, photometricVisualServoing.cpp, photometricVisualServoingWithoutVpServo.cpp, plot2d.cpp, plot3d.cpp, poseVirtualVS.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6AprilTagIBVS.cpp, servoAfma6AprilTagPBVS.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoAfma6FourPoints2DArtVelocity.cpp, servoAfma6FourPoints2DCamVelocityLs_cur.cpp, servoAfma6FourPoints2DCamVelocityLs_cur_integrator.cpp, servoAfma6FourPoints2DCamVelocityLs_des.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6MegaposePBVS.cpp, servoAfma6Point2DArtVelocity.cpp, servoAfma6Point2DCamVelocity.cpp, servoAfma6Points2DCamVelocityEyeToHand.cpp, servoAfma6Segment2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoBebop2.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoFlirPtuIBVS.cpp, servoFrankaIBVS-EyeToHand-Lcur_cVe_eJe.cpp, servoFrankaIBVS-EyeToHand-Lcur_cVf_fVe_eJe.cpp, servoFrankaIBVS-EyeToHand-Ldes_cVf_fVe_eJe.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, servoKinovaJacoCart.cpp, servoKinovaJacoJoint.cpp, servoMomentImage.cpp, servoMomentPoints.cpp, servoMomentPolygon.cpp, servoPioneerPanSegment3D.cpp, servoPioneerPoint2DDepth.cpp, servoPioneerPoint2DDepthWithoutVpServo.cpp, servoPixhawkDroneIBVS.cpp, servoPololuPtuPoint2DJointVelocity.cpp, servoPtu46Point2DArtVelocity.cpp, servoSimu3D_cMcd_CamVelocity.cpp, servoSimu3D_cMcd_CamVelocityWithoutVpServo.cpp, servoSimu3D_cdMc_CamVelocity.cpp, servoSimu3D_cdMc_CamVelocityWithoutVpServo.cpp, servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuCylinder.cpp, servoSimuCylinder2DCamVelocityDisplay.cpp, servoSimuCylinder2DCamVelocityDisplaySecondaryTask.cpp, servoSimuFourPoints2DCamVelocity.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuPoint2DCamVelocity1.cpp, servoSimuPoint2DCamVelocity2.cpp, servoSimuPoint2DCamVelocity3.cpp, servoSimuPoint2DhalfCamVelocity1.cpp, servoSimuPoint2DhalfCamVelocity2.cpp, servoSimuPoint2DhalfCamVelocity3.cpp, servoSimuPoint3DCamVelocity.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocity.cpp, servoSimuSphere2DCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuThetaUCamVelocity.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, servoUniversalRobotsIBVS.cpp, servoUniversalRobotsPBVS.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, simulateCircle2DCamVelocity.cpp, simulateFourPoints2DCartesianCamVelocity.cpp, simulateFourPoints2DPolarCamVelocity.cpp, sonarPioneerReader.cpp, templateTracker.cpp, testAfma6.cpp, testAutoThreshold.cpp, testCameraParametersConversion.cpp, testClient.cpp, testConnectedComponents.cpp, testContours.cpp, testConversion.cpp, testCrop.cpp, testCropAdvanced.cpp, testDisplacement.cpp, testDisplays.cpp, testFeature.cpp, testFeatureMoment.cpp, testFeatureSegment.cpp, testFindMatch.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, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testHSVGradient.cpp, testHistogram.cpp, testImageComparison.cpp, testImageDifference.cpp, testImageFilter.cpp, testImageFilterHSVOldVSNew.cpp, testImageGetValue.cpp, testImageNormalizedCorrelation.cpp, testImageTemplateMatching.cpp, testImgproc.cpp, testIoPGM.cpp, testIoPPM.cpp, testIoTools.cpp, testKalmanAcceleration.cpp, testKalmanVelocity.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint-5.cpp, testKeyPoint-6.cpp, testKeyPoint-7.cpp, testKeyPoint.cpp, testMatrix.cpp, testMatrixConvolution.cpp, testMatrixDeterminant.cpp, testMatrixException.cpp, testMatrixInitialization.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, testNurbs.cpp, testOccipitalStructure_Core_images.cpp, testOccipitalStructure_Core_imu.cpp, testOccipitalStructure_Core_pcl.cpp, testPerformanceLUT.cpp, testPixhawkDroneKeyboard.cpp, testPoint.cpp, testPololuPosition.cpp, testPololuVelocity.cpp, testPolygon.cpp, testPose.cpp, testPoseFeatures.cpp, testPoseRansac.cpp, testPylonGrabber.cpp, testQbSoftHand.cpp, testReadImage.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, testRobotAfma6.cpp, testRobotAfma6Pose.cpp, testRobotBebop2.cpp, testRobotFlirPtu.cpp, testRobotViper650-frames.cpp, testRobotViper850-frames.cpp, testRobotViper850.cpp, testRobotViper850Pose.cpp, testRobust.cpp, testServer.cpp, testSvd.cpp, testTime.cpp, testTrackDot.cpp, testTwistMatrix.cpp, testUDPClient.cpp, testUDPServer.cpp, testUndistortImage.cpp, testUniversalRobotsCartPosition.cpp, testUniversalRobotsCartVelocity.cpp, testUniversalRobotsGetData.cpp, testUniversalRobotsJointPosition.cpp, testUniversalRobotsJointVelocity.cpp, testVideoDeviceDual.cpp, testViper650.cpp, testViper850.cpp, testVirtuose.cpp, testVirtuoseAfma6.cpp, testVirtuoseHapticBox.cpp, testVirtuoseJointLimits.cpp, testVirtuosePeriodicFunction.cpp, testXmlParser.cpp, trackDot.cpp, trackDot2.cpp, trackDot2WithAutoDetection.cpp, trackKltOpencv.cpp, trackMeCircle.cpp, trackMeEllipse.cpp, trackMeLine.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-live.cpp, tutorial-barcode-detector.cpp, tutorial-blob-auto-tracker.cpp, tutorial-blob-tracker-live.cpp, tutorial-canny-hsv.cpp, tutorial-canny.cpp, tutorial-circle-hough.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-dnn-object-detection-live.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-grabber-1394-writer.cpp, tutorial-grabber-1394.cpp, tutorial-grabber-CMU1394.cpp, tutorial-grabber-basler-pylon.cpp, tutorial-grabber-bebop2.cpp, tutorial-grabber-flycapture.cpp, tutorial-grabber-ids-ueye.cpp, tutorial-grabber-opencv.cpp, tutorial-grabber-realsense-T265.cpp, tutorial-grabber-realsense.cpp, tutorial-grabber-structure-core.cpp, tutorial-grabber-v4l2.cpp, tutorial-hsv-range-tuner.cpp, tutorial-hsv-segmentation.cpp, tutorial-ibvs-4pts-display.cpp, tutorial-ibvs-4pts-image-tracking.cpp, tutorial-ibvs-4pts-json.cpp, tutorial-ibvs-4pts-ogre-tracking.cpp, tutorial-ibvs-4pts-ogre.cpp, tutorial-ibvs-4pts-plotter-continuous-gain-adaptive.cpp, tutorial-ibvs-4pts-plotter-gain-adaptive.cpp, tutorial-ibvs-4pts-plotter.cpp, tutorial-ibvs-4pts-wireframe-camera.cpp, tutorial-ibvs-4pts-wireframe-robot-afma6.cpp, tutorial-ibvs-4pts-wireframe-robot-viper.cpp, tutorial-ibvs-4pts.cpp, tutorial-image-colormap.cpp, tutorial-image-converter.cpp, tutorial-image-filter.cpp, tutorial-image-manipulation.cpp, tutorial-image-reader.cpp, tutorial-image-simulator.cpp, tutorial-image-viewer.cpp, tutorial-klt-tracker-live.cpp, tutorial-klt-tracker-with-reinit.cpp, tutorial-klt-tracker.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-apriltag-rs2.cpp, tutorial-mb-generic-tracker-apriltag-webcam.cpp, tutorial-mb-generic-tracker-full.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, tutorial-mb-generic-tracker-rgbd.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-me-ellipse-tracker.cpp, tutorial-me-line-tracker.cpp, tutorial-meandrift.cpp, tutorial-megapose-live-single-object-tracking.cpp, tutorial-munkres-assignment.cpp, tutorial-pioneer-robot.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, tutorial-rbt-realsense.cpp, tutorial-rbt-sequence.cpp, tutorial-simu-pioneer-continuous-gain-adaptive.cpp, tutorial-simu-pioneer-continuous-gain-constant.cpp, tutorial-simu-pioneer-pan.cpp, tutorial-simu-pioneer.cpp, tutorial-undistort.cpp, tutorial-video-manipulation.cpp, tutorial-video-reader.cpp, tutorial-video-recorder.cpp, tutorial-viewer.cpp, videoReader.cpp, visp-acquire-franka-calib-data.cpp, visp-acquire-universal-robots-calib-data.cpp, visp-calibrate-camera.cpp, visp-compute-apriltag-poses.cpp, visp-compute-chessboard-poses.cpp, and wireframeSimulator.cpp.

Definition at line 59 of file vpException.h.

Member Enumeration Documentation

generalExceptionEnum

enum vpException::generalExceptionEnum

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

vpException() [1/5]

vpException::vpException	(	int	code,
		const char *	format,
		va_list	args )

Constructor.

Definition at line 55 of file vpException.cpp.

References code, message, and setMessage().

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

vpException() [2/5]

vpException::vpException	(	int	code,
		const char *	format,
			... )

Constructor.

Definition at line 47 of file vpException.cpp.

References code, message, and setMessage().

vpException() [3/5]

vpException::vpException	(	int	code,
		const std::string &	msg )

Constructor.

Definition at line 45 of file vpException.cpp.

References code, and message.

vpException() [4/5]

BEGIN_VISP_NAMESPACE vpException::vpException

(

int

code

)

Basic destructor. Do nothing but implemented to fit the inheritance from std::exception

Constructor.

Definition at line 43 of file vpException.cpp.

References code, and message.

vpException() [5/5]

vpException::vpException ( )

inlineprotected

forbid the empty constructor (protected)

Definition at line 150 of file vpException.h.

References code, message, and notInitialized.

Member Function Documentation

getCode()

int vpException::getCode

(

)

const

Send the object code.

Examples

catchJsonArrayConversion.cpp.

Definition at line 69 of file vpException.cpp.

References code.

getMessage()

const char * vpException::getMessage

(

)

const

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

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 )

protected

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

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.

Friends And Related Symbol Documentation

operator<<

VISP_EXPORT std::ostream & operator<< ( std::ostream & os, const vpException & art )

friend

Print the error structure.

Definition at line 77 of file vpException.cpp.

References operator<<, and vpException().

Referenced by operator<<.

Member Data Documentation

code

int vpException::code

protected

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

protected

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