IOerror Class Reference

Report an I/O error. More...

#include <src/OpenFOAM/db/error/error.H>

---

Detailed Description

Report an I/O error.

Definition at line 194 of file error.H.

Inheritance diagram for IOerror:

Collaboration diagram for IOerror:

List of all members.

Public Member Functions
	IOerror (const string &title)
	Construct from title string.
	IOerror (const dictionary &errDict)
	Construct from dictionary.
virtual	~IOerror () throw ()
const string &	ioFileName () const
label	ioStartLineNumber () const
label	ioEndLineNumber () const
OSstream &	operator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const string &ioFileName, const label ioStartLineNumber=-1, const label ioEndLineNumber=-1)
	Convert to Ostream.
OSstream &	operator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const IOstream &)
	Convert to Ostream.
OSstream &	operator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const dictionary &)
	Convert to Ostream.
	operator dictionary () const
	Create and return a dictionary.
void	exit (const int errNo=1)
	Exit : can be called for any error to exit program.
void	abort ()
	Abort : used to stop code for fatal errors.
Friends
Ostream &	operator<< (Ostream &, const IOerror &)

---

Constructor & Destructor Documentation

IOerror

(

const string &

title  )

Construct from title string.

Definition at line 35 of file IOerror.C.

IOerror

(

const dictionary &

errDict  )

Construct from dictionary.

Definition at line 44 of file IOerror.C.

~IOerror

(

)

throw () [virtual]

Definition at line 53 of file IOerror.C.

---

Member Function Documentation

const string& ioFileName

(

)

const [inline]

Definition at line 223 of file error.H.

Referenced by Foam::operator<<().

label ioStartLineNumber

(

)

const [inline]

Definition at line 228 of file error.H.

Referenced by Foam::operator<<().

label ioEndLineNumber

(

)

const [inline]

Definition at line 233 of file error.H.

Referenced by Foam::operator<<().

Foam::OSstream & operator()	(	const char *	functionName,
		const char *	sourceFileName,
		const int	sourceFileLineNumber,
		const string &	ioFileName,
		const label	ioStartLineNumber = -1,
		const label	ioEndLineNumber = -1
	)

Convert to Ostream.

Prints basic message and then returns Ostream for further info.

Reimplemented from messageStream.

Definition at line 58 of file IOerror.C.

References error::operator()().

Foam::OSstream & operator()	(	const char *	functionName,
		const char *	sourceFileName,
		const int	sourceFileLineNumber,
		const IOstream &	ioStream
	)

Convert to Ostream.

Prints basic message and then returns Ostream for further info.

Reimplemented from messageStream.

Definition at line 77 of file IOerror.C.

Foam::OSstream & operator()	(	const char *	functionName,
		const char *	sourceFileName,
		const int	sourceFileLineNumber,
		const dictionary &	dict
	)

Convert to Ostream.

Prints basic message and then returns Ostream for further info.

Reimplemented from messageStream.

Definition at line 97 of file IOerror.C.

operator dictionary

(

)

const

Create and return a dictionary.

Reimplemented from error.

void exit

(

const int

errNo = 1  )

Exit : can be called for any error to exit program.

Reimplemented from error.

Definition at line 131 of file IOerror.C.

References Foam::abort(), dictionary::add(), JobInfo::constructed, Foam::endl(), Foam::exit(), Pstream::exit(), JobInfo::exit(), Foam::jobInfo, Pstream::parRun(), and Foam::Perr.

Referenced by Foam::exit(), Istream::operator()(), and IFstream::operator()().

void abort

(

)

Abort : used to stop code for fatal errors.

Reimplemented from error.

Definition at line 172 of file IOerror.C.

References Pstream::abort(), Foam::abort(), JobInfo::abort(), dictionary::add(), JobInfo::constructed, Foam::endl(), Foam::jobInfo, Pstream::parRun(), and Foam::Perr.

Referenced by Foam::abort().

---

Friends And Related Function Documentation

Ostream& operator<<	(	Ostream &	,
		const IOerror &
	)		[friend]

---

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

• src/OpenFOAM/db/error/error.H
• src/OpenFOAM/db/error/IOerror.C