IOerror Class Reference

Report an I/O error. More...

Inheritance diagram for IOerror:

Collaboration diagram for IOerror:

Public Member Functions
	IOerror (const string &title)
	Construct from title string. More...
	IOerror (const dictionary &)
	Construct from dictionary. More...
virtual	~IOerror () throw ()
	Destructor. More...
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 OSstream. More...
OSstream &	operator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const IOstream &)
	Convert to OSstream. More...
OSstream &	operator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const dictionary &)
	Convert to OSstream. More...
	operator dictionary () const
	Create and return a dictionary. More...
void	exit (const int errNo=1)
	Exit : can be called for any error to exit program. More...
void	abort ()
	Abort : used to stop code for fatal errors. More...
Public Member Functions inherited from error
	error (const string &title)
	Construct from title string. More...
	error (const dictionary &)
	Construct from dictionary. More...
	error (const error &)
	Copy constructor. More...
virtual	~error () throw ()
	Destructor. More...
string	message () const
const string &	functionName () const
const string &	sourceFileName () const
label	sourceFileLineNumber () const
void	throwExceptions ()
void	dontThrowExceptions ()
OSstream &	operator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber=0)
	Convert to OSstream. More...
OSstream &	operator() (const string &functionName, const char *sourceFileName, const int sourceFileLineNumber=0)
	Convert to OSstream. More...
	operator OSstream & ()
	Convert to OSstream. More...
OSstream &	operator() ()
	Explicitly convert to OSstream for << operations. More...
	operator dictionary () const
	Create and return a dictionary. More...
void	exit (const int errNo=1)
	Exit : can be called for any error to exit program. More...
void	abort ()
	Abort : used to stop code for fatal errors. More...
Public Member Functions inherited from messageStream
	messageStream (const string &title, errorSeverity, const int maxErrors=0)
	Construct from components. More...
	messageStream (const dictionary &)
	Construct from dictionary. More...
const string &	title () const
	Return the title of this error type. More...
int	maxErrors () const
	Return the maximum number of errors before program termination. More...
int &	maxErrors ()
	Return non-const access to the maximum number of errors before. More...
OSstream &	masterStream (const label communicator)
	Convert to OSstream. More...
OSstream &	operator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber=0)
	Convert to OSstream. More...
OSstream &	operator() (const string &functionName, const char *sourceFileName, const int sourceFileLineNumber=0)
	Convert to OSstream. More...
OSstream &	operator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const string &ioFileName, const label ioStartLineNumber=-1, const label ioEndLineNumber=-1)
	Convert to OSstream. More...
OSstream &	operator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const IOstream &)
	Convert to OSstream. More...
OSstream &	operator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const dictionary &)
	Convert to OSstream. More...
	operator OSstream & ()
	Convert to OSstream for << operations. More...
OSstream &	operator() ()
	Explicitly convert to OSstream for << operations. More...

Static Public Member Functions
static void	SafeFatalIOError (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const IOstream &, const string &msg)
	Print basic message and exit. Uses cerr if streams not constructed. More...
Static Public Member Functions inherited from error
static void	safePrintStack (std::ostream &)
	Helper function to print a stack (if OpenFOAM IO not yet. More...
static void	printStack (Ostream &)
	Helper function to print a stack. More...

Friends
Ostream &	operator<< (Ostream &, const IOerror &)

Additional Inherited Members
Public Types inherited from messageStream
enum	errorSeverity { INFO, WARNING, SERIOUS, FATAL }
	Severity flags. More...
Static Public Attributes inherited from messageStream
static int	level
Protected Attributes inherited from error
string	functionName_
string	sourceFileName_
label	sourceFileLineNumber_
bool	abort_
bool	throwExceptions_
OStringStream *	messageStreamPtr_
Protected Attributes inherited from messageStream
string	title_
errorSeverity	severity_
int	maxErrors_
int	errorCount_

Detailed Description

Report an I/O error.

Definition at line 196 of file error.H.

Constructor & Destructor Documentation

IOerror() [1/2]

IOerror

(

const string &

title

)

Construct from title string.

Definition at line 35 of file IOerror.C.

IOerror() [2/2]

IOerror

(

const dictionary &

errDict

)

Construct from dictionary.

Definition at line 44 of file IOerror.C.

~IOerror()

~IOerror ( ) throw ( )

virtual

Destructor.

Definition at line 53 of file IOerror.C.

Member Function Documentation

ioFileName()

const string& ioFileName ( ) const

inline

Definition at line 224 of file error.H.

Referenced by IOerror::operator()(), Foam::operator<<(), and IOerror::SafeFatalIOError().

Here is the caller graph for this function:

ioStartLineNumber()

label ioStartLineNumber ( ) const

inline

Definition at line 229 of file error.H.

Referenced by IOerror::operator()(), Foam::operator<<(), and IOerror::SafeFatalIOError().

Here is the caller graph for this function:

ioEndLineNumber()

label ioEndLineNumber ( ) const

inline

Definition at line 234 of file error.H.

References error::abort(), error::exit(), Foam::FatalError, Foam::FatalIOError, error::functionName(), error::operator<<, error::sourceFileLineNumber(), error::sourceFileName(), and Foam::T().

Referenced by IOerror::operator()(), Foam::operator<<(), and IOerror::SafeFatalIOError().

Here is the call graph for this function:

Here is the caller graph for this function:

operator()() [1/3]

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 OSstream.

Prints basic message and returns OSstream for further info.

Definition at line 58 of file IOerror.C.

References IOerror::ioEndLineNumber(), IOerror::ioFileName(), IOerror::ioStartLineNumber(), error::operator()(), error::sourceFileLineNumber(), and error::sourceFileName().

Here is the call graph for this function:

operator()() [2/3]

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

Convert to OSstream.

Prints basic message and returns OSstream for further info.

Definition at line 77 of file IOerror.C.

References error::functionName(), error::sourceFileLineNumber(), and error::sourceFileName().

Here is the call graph for this function:

operator()() [3/3]

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

Convert to OSstream.

Prints basic message and returns OSstream for further info.

Definition at line 97 of file IOerror.C.

References dict, error::functionName(), IOerror::SafeFatalIOError(), error::sourceFileLineNumber(), and error::sourceFileName().

Here is the call graph for this function:

SafeFatalIOError()

void SafeFatalIOError ( const char *  functionName, const char *  sourceFileName, const int  sourceFileLineNumber, const IOstream &  ioStream, const string &  msg  )

static

Print basic message and exit. Uses cerr if streams not constructed.

yet (at startup). Use in startup parsing instead of FatalError.

Definition at line 117 of file IOerror.C.

References dictionary::add(), jobInfo::constructed, Foam::endl(), Foam::exit(), IOerror::exit(), Foam::FatalIOError, IOerror::ioEndLineNumber(), IOerror::ioFileName(), IOerror::ioStartLineNumber(), IOstream::lineNumber(), IOstream::name(), and dictionary::remove().

Referenced by IOerror::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

operator dictionary()

operator dictionary

(

)

const

Create and return a dictionary.

exit()

void exit

(

const int

errNo = 1

)

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

Definition at line 170 of file IOerror.C.

References IOerror::abort(), error::abort_, dictionary::add(), jobInfo::constructed, Foam::endl(), jobInfo::exit(), UPstream::exit(), Foam::jobInfo_, error::messageStreamPtr_, UPstream::parRun(), Foam::Perr, OStringStream::rewind(), and error::throwExceptions_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

abort()

void abort

(

)

Abort : used to stop code for fatal errors.

Definition at line 211 of file IOerror.C.

References jobInfo::abort(), UPstream::abort(), error::abort_, dictionary::add(), jobInfo::constructed, Foam::endl(), Foam::jobInfo_, error::messageStreamPtr_, UPstream::parRun(), Foam::Perr, error::printStack(), OStringStream::rewind(), and error::throwExceptions_.

Referenced by Foam::abort(), and IOerror::exit().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

operator<<

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