Safir::Dob::Typesystem::ToolSupport::ParseError Class Reference

Exception used to report errors in dou- and dom- files. More...

#include <Safir/Dob/Typesystem/ToolSupport/ParseError.h>

Inheritance diagram for Safir::Dob::Typesystem::ToolSupport::ParseError:

Collaboration diagram for Safir::Dob::Typesystem::ToolSupport::ParseError:

Public Member Functions
	ParseError (const std::string &label, const std::string &description, const std::string &file, int errorId)
	Constructor - Creates a ParseError object.
	~ParseError () throw ()
	Destructor.
const std::string &	Label () const throw ()
	Get short error description.
const std::string &	Description () const throw ()
	Get Internaled error description.
const std::string &	File () const throw ()
	Get file where error occured.
int	ErrorId () const
	Get an error identifier that can be used to find out exactly where this error was generated.
const char *	what () const override throw ()
	Get error informtation on the form "Label; Description; File; ErrorId".

Detailed Description

Exception used to report errors in dou- and dom- files.

Constructor & Destructor Documentation

ParseError()

Safir::Dob::Typesystem::ToolSupport::ParseError::ParseError	(	const std::string &	label,
		const std::string &	description,
		const std::string &	file,
		int	errorId )

Constructor - Creates a ParseError object.

Parameters

label	[in] - Short description of the error.
description	[in] - Internaled description of the error.
file	[in] - Name of the dou- or dom-file that caused the error.
errorId	[in] - Id of this specific error. Can be used by test code and developvers to locate from where this error was thrown.

~ParseError()

Safir::Dob::Typesystem::ToolSupport::ParseError::~ParseError	(		)
throw	(	)

Destructor.

Member Function Documentation

Description()

const std::string & Safir::Dob::Typesystem::ToolSupport::ParseError::Description	(		)	const
throw	(	)

Get Internaled error description.

Returns

Error description.

ErrorId()

int Safir::Dob::Typesystem::ToolSupport::ParseError::ErrorId

(

)

const

Get an error identifier that can be used to find out exactly where this error was generated.

Mostly intended for test and development.

Returns

Error id.

File()

const std::string & Safir::Dob::Typesystem::ToolSupport::ParseError::File	(		)	const
throw	(	)

Get file where error occured.

Returns

Complete path to a dou- or dom- file.

Label()

const std::string & Safir::Dob::Typesystem::ToolSupport::ParseError::Label	(		)	const
throw	(	)

Get short error description.

Returns

Error label.

what()

const char * Safir::Dob::Typesystem::ToolSupport::ParseError::what ( ) const throw (  )

override

Get error informtation on the form "Label; Description; File; ErrorId".

Inherited from std:exception.

Returns

Error information.