IlvStIError Class Reference

Inspector class. More...

#include <ivstudio/inspectors/insperr.h>

Inherits IlvStObject.

List of all members.

Public Types
enum	Severity { Information, Warning, Fatal }
	This enumeration type defines the error severity. More...
Public Member Functions
	IlvStIError (const char *msg, const char *param1, const char *param2, Severity sev=Fatal)
	Constructor from a computed message.
	IlvStIError (const char *msg, const char *param1, Severity sev=Fatal)
	Constructor from a computed message.
	IlvStIError (const char *msg=0, Severity=Fatal)
	Constructor from a single message.
virtual char *	getMessage (IlvDisplay *display) const
	Returns the error message.
Severity	getSeverity () const
	Returns the severity level of the error.
void	setSeverity (Severity severity)
	Sets the severity level of the error.

---

Detailed Description

Inspector class.

Library: ivstudio

Errors generated by inspector classes are objects of this class. This class defines an error message and a severity level.

See also:

IlvStIAccessor.

---

Member Enumeration Documentation

enum IlvStIError::Severity

This enumeration type defines the error severity.

Enumerator:

Information	The error is an information.
Warning	The error is a warning.
Fatal	The error is an important error, the application will be stopped.

---

Constructor & Destructor Documentation

IlvStIError::IlvStIError	(	const char *	msg = 0,
		Severity	= Fatal
	)

Constructor from a single message.

Parameters:

	msg	The error message, it can be a key to a message database.
	sev	The error severity.

IlvStIError::IlvStIError	(	const char *	msg,
		const char *	param1,
		Severity	sev = Fatal
	)

Constructor from a computed message.

This error message contains one or more 1 substrings, which will be replaced by the param1 parameter. Let us suppose that msg equals to "The name %1 is not valid" , and param1 is "2b3" the final error message will be as follows "The name 2b3 is not valid".

Parameters:

	msg	The error message, it can be a key to a message database.
	param1	The value of the named value "%1".
	sev	The error severity.

IlvStIError::IlvStIError	(	const char *	msg,
		const char *	param1,
		const char *	param2,
		Severity	sev = Fatal
	)

Constructor from a computed message.

This error message contains one or more 1 and 2 substrings, which will be replaced by the param1 and the param2 parameters, respectively. Let us suppose that msg equals to "The %1 county is not in %2" , param1 is "Madison", and param2 is "France", the final error message will be as follows "The Madison county is not in France".

Parameters:

	msg	The error message, it can be a key to a message database.
	param1	The value of the named value "%1".
	param2	The value of the named value "%2".
	sev	The error severity.

---

Member Function Documentation

virtual char* IlvStIError::getMessage

(

IlvDisplay *

display

)

const [virtual]

Returns the error message.

Parameters:

display

It is used to retrieve the message matching the key when the message is stored into a message database.

Returns:

The error message.

Severity IlvStIError::getSeverity

(

)

const

Returns the severity level of the error.

Returns:

The severity level of the error.

void IlvStIError::setSeverity

(

Severity

severity

)

Sets the severity level of the error.

Parameters:

severity

The new error severity.