vpSimulatorException Class Reference

#include <visp3/ar/vpSimulatorException.h>

Inheritance diagram for vpSimulatorException:

Public Types
enum	errorSimulatorCodeEnum {   ioError, noFileNameError, notInitializedError, windowSizeNotInitializedError,   badInitializationError }
enum	generalExceptionEnum {   memoryAllocationError, memoryFreeError, functionNotImplementedError, ioError,   cannotUseConstructorError, notImplementedError, divideByZeroError, dimensionError,   fatalError, badValue, notInitialized }

Public Member Functions
	vpSimulatorException (const int id, const char *format,...)
	vpSimulatorException (const int id, const std::string &msg)
	vpSimulatorException (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 vpSimulator class and its derivates.

Definition at line 71 of file vpSimulatorException.h.

Member Enumeration Documentation

errorSimulatorCodeEnum

enum vpSimulatorException::errorSimulatorCodeEnum

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

Enumerator
ioError
noFileNameError
notInitializedError
windowSizeNotInitializedError
badInitializationError

Definition at line 78 of file vpSimulatorException.h.

generalExceptionEnum

enum vpException::generalExceptionEnum

inherited

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

vpSimulatorException() [1/3]

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

Definition at line 46 of file vpSimulatorException.cpp.

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

vpSimulatorException() [2/3]

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

Definition at line 55 of file vpSimulatorException.cpp.

vpSimulatorException() [3/3]

vpSimulatorException::vpSimulatorException ( const int  id )

explicit

Definition at line 57 of file vpSimulatorException.cpp.

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

const char * vpException::getMessage ( void  ) const

inherited

send a pointer on the array of char related to the error string. Cannot be NULL.

Examples:

fernClassifier.cpp, moveBiclops.cpp, servoViper650FourPoints2DArtVelocityInteractionCurrent.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent-SR300.cpp, servoViper650FourPoints2DCamVelocityInteractionCurrent.cpp, servoViper650Point2DCamVelocity.cpp, servoViper850Point2DArtVelocity-jointAvoidance-gpa.cpp, testConversion.cpp, testDisplays.cpp, testReadImage.cpp, testRobotViper650-frames.cpp, testRobotViper850-frames.cpp, testTrackDot.cpp, trackMeNurbs.cpp, tutorial-apriltag-detector-live.cpp, tutorial-apriltag-detector.cpp, tutorial-barcode-detector.cpp, tutorial-face-detector-live.cpp, tutorial-face-detector.cpp, tutorial-image-display-scaled-auto.cpp, tutorial-image-display-scaled-manu.cpp, tutorial-image-display.cpp, tutorial-image-reader.cpp, tutorial-mb-tracker-stereo.cpp, tutorial-pose-from-points-image.cpp, tutorial-pose-from-qrcode-image.cpp, and tutorial-video-reader.cpp.

Definition at line 90 of file vpException.cpp.

References vpException::message.

Referenced by vpTemplateTracker::trackPyr().

getStringMessage()

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

inherited

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

Examples:

grabFlyCapture.cpp, parse-argv2.cpp, testCrop.cpp, testCropAdvanced.cpp, testMatrixDeterminant.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, testPoseFeatures.cpp, testSvd.cpp, testViper650.cpp, testViper850.cpp, testVirtuose.cpp, testVirtuoseAfma6.cpp, testVirtuoseHapticBox.cpp, testVirtuoseJointLimits.cpp, testVirtuosePeriodicFunction.cpp, and tutorial-grabber-flycapture.cpp.

Definition at line 92 of file vpException.cpp.

References vpException::message.

setMessage()

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

protectedinherited

Set the message container.

Definition at line 78 of file vpException.cpp.

References vpException::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(), 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:

grabRealSense.cpp, grabRealSense2.cpp, grabV4l2MultiCpp11Thread.cpp, testAprilTag.cpp, testAutoThreshold.cpp, testConnectedComponents.cpp, testContours.cpp, testFloodFill.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, testPerformanceLUT.cpp, testRealSense_R200.cpp, testRealSense_SR300.cpp, testUDPClient.cpp, testUDPServer.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, and tutorial-mb-generic-tracker-stereo.cpp.

Definition at line 102 of file vpException.cpp.

References vpException::message.

Referenced by vpMbtDistanceLine::computeInteractionMatrixError(), vpKeyPoint::computePose(), vpMbDepthDenseTracker::loadConfigFile(), vpMbDepthNormalTracker::loadConfigFile(), and vpMbGenericTracker::track().

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

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