A class that encapsulates information about a compilation error. More...

#include <omScriptingError.h>

Public Member Functions
	Error (const Position &newPosition)
	Create a new error object with no error string. More...

	Error (const Position &newPosition, const Char *newDescription)
	Create a new error object with the specified error string. More...

	Error (const Position &newPosition, const UTF8String &newDescription)
	Create a new error object with the specified error string. More...

const Position &	getPosition () const
	Return a reference to an object representing the position where this error occurred. More...

const UTF8String &	getDescription () const
	Return a reference to a string describing the error that occurred. More...

Bool	operator< (const Error &other) const
	Return whether or not this position is earlier than another. More...

Bool	operator<= (const Error &other) const
	Return whether or not this position is earlier or the same as another. More...

Bool	operator> (const Error &other) const
	Return whether or not this position is later than another. More...

Bool	operator>= (const Error &other) const
	Return whether or not this position is later or the same as another. More...

Detailed Description

A class that encapsulates information about a compilation error.

Constructor & Destructor Documentation

om::scripting::util::Error::Error ( const Position & newPosition )

inline

Create a new error object with no error string.

om::scripting::util::Error::Error	(	const Position &	newPosition,
		const Char *	newDescription
	)

inline

Create a new error object with the specified error string.

om::scripting::util::Error::Error	(	const Position &	newPosition,
		const UTF8String &	newDescription
	)

inline

Create a new error object with the specified error string.

const Position& om::scripting::util::Error::getPosition ( ) const

inline

Return a reference to an object representing the position where this error occurred.

const UTF8String& om::scripting::util::Error::getDescription ( ) const

inline

Return a reference to a string describing the error that occurred.

Bool om::scripting::util::Error::operator< ( const Error & other ) const

inline

Return whether or not this position is earlier than another.

Bool om::scripting::util::Error::operator<= ( const Error & other ) const

inline

Return whether or not this position is earlier or the same as another.

Bool om::scripting::util::Error::operator> ( const Error & other ) const

inline

Return whether or not this position is later than another.

Bool om::scripting::util::Error::operator>= ( const Error & other ) const

inline

Return whether or not this position is later or the same as another.

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