UserDefinedCheckFailureException Class Reference

The exception to throw when a user check on a parameter fails. More...

Inheritance diagram for UserDefinedCheckFailureException:

Public Member Functions
	UserDefinedCheckFailureException (const char *paramName, const char *paramValue, const char *description) throw ()
	Constructor. More...
	UserDefinedCheckFailureException (const UserDefinedCheckFailureException &other) throw ()
	Copy constructor. More...
virtual	~UserDefinedCheckFailureException () throw ()
	Destructor. More...
const char *	description () const throw ()
	Returns the error description. More...
UserDefinedCheckFailureException &	operator= (const UserDefinedCheckFailureException &other) throw ()
	Copy operator. More...
const char *	paramName () const throw ()
	Returns the name of the parameter. More...
const char *	paramValue () const throw ()
	Returns the value of the parameter. More...
virtual const char *	what () const throw ()
	Returns a C string describing the exception. More...

Detailed Description

The exception to throw when a user check on a parameter fails.

Use this when a user-defined check on a parameter fails when configuring an object. The ConfigurationHelper::throwUserConfigError() function provides a convenient way of throwing an exception of this type (see function description)

Definition at line 1119 of file configurationexceptions.h.

Constructor & Destructor Documentation

UserDefinedCheckFailureException ( const char *  paramName, const char *  paramValue, const char *  description  ) throw ( )

inline

Constructor.

Parameters

paramName	the name of the parameter on which the check failed. The buffer for this is at most 256 characters (including the '\0' terminator)
paramValue	the value of the parameter which caused the check to fail. The buffer for this is at most 256 characters (including the '\0' terminator)
description	a description of the error. The buffer for this is at most 256 characters (including the '\0' terminator)

Definition at line 1135 of file configurationexceptions.h.

UserDefinedCheckFailureException ( const UserDefinedCheckFailureException &  other ) throw ( )

inline

Copy constructor.

Parameters

other

the exception to copy

Definition at line 1153 of file configurationexceptions.h.

virtual ~UserDefinedCheckFailureException ( ) throw ( )

inlinevirtual

Destructor.

Definition at line 1193 of file configurationexceptions.h.

Member Function Documentation

const char* description ( ) const throw ( )

inline

Returns the error description.

Returns

the error description

Definition at line 1232 of file configurationexceptions.h.

UserDefinedCheckFailureException& operator= ( const UserDefinedCheckFailureException &  other ) throw ( )

inline

Copy operator.

Parameters

other

the exception to copy

Definition at line 1171 of file configurationexceptions.h.

const char* paramName ( ) const throw ( )

inline

Returns the name of the parameter.

Returns

the name of the parameter

Definition at line 1212 of file configurationexceptions.h.

const char* paramValue ( ) const throw ( )

inline

Returns the value of the parameter.

Returns

the value of the parameter

Definition at line 1222 of file configurationexceptions.h.

virtual const char* what ( ) const throw ( )

inlinevirtual

Returns a C string describing the exception.

Returns

a C string describing the exception

Definition at line 1202 of file configurationexceptions.h.

---

The documentation for this class was generated from the following file:

• configuration/include/configurationexceptions.h