Report an I/O error. More...

#include <error.H>

Inheritance diagram for IOerror:

Collaboration diagram for IOerror:

Public Member Functions
	IOerror (const char *title)
	Construct from title string.
	IOerror (const std::string &title)
	Construct from title string.
	IOerror (const dictionary &errDict)
	Construct from dictionary.
virtual	~IOerror () noexcept
	Destructor.
const string &	ioFileName () const noexcept
	The currently defined IO name for output messages.
label	ioStartLineNumber () const noexcept
	The currently defined IO start-line number for output messages.
label	ioEndLineNumber () const noexcept
	The currently defined IO end-line number.
OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, string ioFileName, const label ioStartLineNumber=-1, const label ioEndLineNumber=-1)
	Define basic print message.
OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const IOstream &ioStream)
	Define basic print message for IO stream.
OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const dictionary &dict)
	Define basic print message for dictionary entries. Uses the dictionary::relativeName() on output.
OSstream &	operator() (const std::string &where, const IOstream &ioStream)
	Define basic print message for IO stream, independent of a source-file reference. Uses the dictionary::relativeName() on output.
OSstream &	operator() (const std::string &where, const dictionary &dict)
	Define basic print message for dictionary entries, independent of a source-file reference. Uses the dictionary::relativeName() on output.
	operator dictionary () const
	Extract a dictionary representation of the error information.
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.
virtual void	write (Ostream &os, const bool withTitle=true) const
	Print error message.
Public Member Functions inherited from error
	error (const char *title)
	Construct from title string.
	error (const std::string &title)
	Construct from title string.
	error (const dictionary &errDict)
	Construct from dictionary.
	error (const error &err)
	Copy construct.
virtual	~error () noexcept
	Destructor.
string	message () const
	The accumulated error message.
void	clear () const
	Clear any accumulated error messages.
const string &	functionName () const noexcept
	The currently defined function name for output messages.
const string &	sourceFileName () const noexcept
	The currently defined source-file name for output messages.
int	sourceFileLineNumber () const noexcept
	The currently defined source-file line number for output messages.
bool	throwing () const noexcept
	Return the current exception throwing state (on or off).
bool	throwing (const bool on) noexcept
	Specify exception throwing state (on or off).
OSstream &	stream ()
	Return OSstream for output operations.
	operator OSstream & ()
	Implicit cast to OSstream for << operations.
OSstream &	operator() ()
	Explicit convert to OSstream for << operations.
OSstream &	operator() (string functionName, const char *sourceFileName=nullptr, const int sourceFileLineNumber=-1)
	Define basic print message with originating function name, optionally with 'source file, line number'.
OSstream &	operator() (const char functionName, const char sourceFileName=nullptr, const int sourceFileLineNumber=-1)
	Define basic print message with originating function name, optionally with 'source file, line number'.
	operator dictionary () const
	Extract a dictionary representation of the error information.
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.
bool	throwExceptions (const bool on=true) noexcept
	Specify exception throwing state (default is on).
bool	dontThrowExceptions () noexcept
	Deactivate exception throwing.
Public Member Functions inherited from messageStream
	messageStream (errorSeverity severity, int maxErrors=0, bool use_stderr=false)
	Construct untitled with given characteristics.
	messageStream (const char *title, errorSeverity severity, int maxErrors=0, bool use_stderr=false)
	Construct from components.
	messageStream (string title, errorSeverity severity, int maxErrors=0, bool use_stderr=false)
	Construct from components.
	messageStream (const dictionary &dict)
	Construct from dictionary as Fatal, extracting 'title'.
const string &	title () const noexcept
	The title of this error type.
int	maxErrors () const noexcept
	The maximum number of errors before program termination.
int	maxErrors (int nErrors) noexcept
	Set the maximum number of errors before program termination.
OSstream &	stream (OSstream *alternative=nullptr, int communicator=-1)
	Return OSstream for output operations.
OSstream &	masterStream (int communicator)
	Return OSstream for output operations on the master process only, Snull on other processes.
std::ostream &	stdStream ()
	Return std::ostream for output operations.
OSstream &	deprecated (const int afterVersion, const char functionName=nullptr, const char sourceFileName=nullptr, const int sourceFileLineNumber=0)
	Report deprecation (after specified API version) with 'From function-name, source file, line number'.
	operator OSstream & ()
	Implicit cast to OSstream for << operations.
OSstream &	operator() ()
	Explicitly convert to OSstream for << operations.
OSstream &	operator() (const std::string &functionName, const char *sourceFileName=nullptr, const int sourceFileLineNumber=0)
	Report 'From function-name', optionally with 'source file, line number'.
OSstream &	operator() (const char functionName, const char sourceFileName=nullptr, const int sourceFileLineNumber=0)
	Report 'From function-name', optionally with 'source file, line number'.
OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const std::string &ioFileName, const label ioStartLineNumber=-1, const label ioEndLineNumber=-1)
	Report 'From function-name, source file, line number' as well as io-file name and location.
OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const IOstream &)
	Report 'From function-name, source file, line number' as well as io-file name and location.
OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const dictionary &)
	Report 'From function-name, source file, line number' as well as io-file name and location.

Static Public Member Functions
static void	SafeFatalIOError (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const IOstream &ioStream, const std::string &msg)
	Print basic message and exit.
Static Public Member Functions inherited from error
static bool	master (const int communicator=-1)
	Like Pstream::master but with a Pstream::parRun guard in case Pstream has not yet been initialised.
static bool	warnAboutAge (const int version) noexcept
	Test if an age warning should be emitted.
static bool	warnAboutAge (const char *what, const int version)
	Emit warning on stderr about something being old.
static void	safePrintStack (std::ostream &os, int size=-1)
	Helper function to print a stack, with optional upper limit. Used when OpenFOAM IO not yet initialised.
static void	printStack (Ostream &os, int size=-1)
	Helper function to print a stack, with optional upper limit.
static bool	useAbort ()
	True if FOAM_ABORT is on.

Additional Inherited Members
Public Types inherited from error
enum class	handlerTypes : char { DEFAULT = 0 , IGNORE , WARN , STRICT }
	Handling of errors. The exact handling depends on the local context. More...
Public Types inherited from messageStream
enum	errorSeverity : int { INFO = 1 , WARNING , SERIOUS , FATAL , USE_STDERR = 0x80 }
	Message type, error severity flags. More...
Static Public Attributes inherited from error
static const Enum< handlerTypes >	handlerNames
	Names of the error handler types.
Static Public Attributes inherited from messageStream
static int	level
	The output level (verbosity) of messages.
static int	redirect
	The output redirection of messages.
Protected Member Functions inherited from error
void	simpleExit (const int errNo, const bool isAbort)
	Exit or abort, without throwing or job control handling.
Protected Attributes inherited from error
string	functionName_
string	sourceFileName_
int	sourceFileLineNumber_
bool	throwing_
std::unique_ptr< OStringStream >	messageStreamPtr_
Protected Attributes inherited from messageStream
string	title_
	The title of this error type.
int	severity_
	The message type / error severity, possibly with USE_STDERR mask.
int	maxErrors_
	The maximum number of errors before program termination.
int	errorCount_
	The current number of errors counted.

Detailed Description

Report an I/O error.

Definition at line 367 of file error.H.

Constructor & Destructor Documentation

◆ IOerror() [1/3]

IOerror ( const char * title )

explicit

Construct from title string.

Definition at line 34 of file IOerror.C.

References error::error(), and messageStream::title().

Referenced by IOerror().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IOerror() [2/3]

IOerror ( const std::string & title )

inlineexplicit

Construct from title string.

Definition at line 398 of file error.H.

References IOerror(), and messageStream::title().

Here is the call graph for this function:

◆ IOerror() [3/3]

IOerror ( const dictionary & errDict )

explicit

Construct from dictionary.

Definition at line 43 of file IOerror.C.

References error::error().

Here is the call graph for this function:

◆ ~IOerror()

~IOerror ( )

virtualnoexcept

Destructor.

Definition at line 54 of file IOerror.C.

References Foam::noexcept.

Member Function Documentation

◆ ioFileName()

const string & ioFileName ( ) const

inlinenoexcept

The currently defined IO name for output messages.

Definition at line 417 of file error.H.

References ioFileName(), and Foam::noexcept.

Referenced by ioFileName(), operator()(), and write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ioStartLineNumber()

label ioStartLineNumber ( ) const

inlinenoexcept

The currently defined IO start-line number for output messages.

Definition at line 425 of file error.H.

References Foam::noexcept.

Referenced by operator()(), and write().

Here is the caller graph for this function:

◆ ioEndLineNumber()

label ioEndLineNumber ( ) const

inlinenoexcept

The currently defined IO end-line number.

Definition at line 433 of file error.H.

References Foam::noexcept.

Referenced by operator()(), and write().

Here is the caller graph for this function:

◆ operator()() [1/5]

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

Define basic print message.

Returns: OSstream for further operations

Definition at line 60 of file IOerror.C.

References error::functionName(), ioEndLineNumber(), ioFileName(), ioStartLineNumber(), os(), error::sourceFileLineNumber(), and error::sourceFileName().

Here is the call graph for this function:

◆ operator()() [2/5]

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

Define basic print message for IO stream.

Returns: OSstream for further operations

Definition at line 85 of file IOerror.C.

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

Here is the call graph for this function:

◆ operator()() [3/5]

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

Define basic print message for dictionary entries. Uses the dictionary::relativeName() on output.

Returns: OSstream for further operations

Definition at line 105 of file IOerror.C.

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

Here is the call graph for this function:

◆ operator()() [4/5]

Foam::OSstream & operator()	(	const std::string &	where,
		const IOstream &	ioStream )

Define basic print message for IO stream, independent of a source-file reference. Uses the dictionary::relativeName() on output.

Returns: OSstream for further operations

Definition at line 125 of file IOerror.C.

◆ operator()() [5/5]

Foam::OSstream & operator()	(	const std::string &	where,
		const dictionary &	dict )

Define basic print message for dictionary entries, independent of a source-file reference. Uses the dictionary::relativeName() on output.

Returns: OSstream for further operations

Definition at line 143 of file IOerror.C.

References dict.

◆ SafeFatalIOError()

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

static

Print basic message and exit.

Uses cerr if streams not yet constructed (at startup). Use in startup parsing instead of FatalError.

Definition at line 161 of file IOerror.C.

References JobInfo::constructed, Foam::exit(), Foam::FatalIOError, error::functionName(), IOstream::lineNumber(), Foam::nl, IOstream::relativeName(), error::sourceFileLineNumber(), and error::sourceFileName().

Here is the call graph for this function:

◆ operator dictionary()

operator dictionary ( ) const

Extract a dictionary representation of the error information.

References os().

Here is the call graph for this function:

◆ exit()

void exit ( const int errNo = 1 )

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

Definition at line 240 of file IOerror.C.

Referenced by Foam::exit().

Here is the caller graph for this function:

◆ abort()

void abort ( )

Abort : used to stop code for fatal errors.

Definition at line 246 of file IOerror.C.

Referenced by Foam::abort().

Here is the caller graph for this function:

◆ write()

void write	(	Ostream &	os,
		const bool	withTitle = true ) const

virtual

Print error message.

Reimplemented from error.

Definition at line 252 of file IOerror.C.

References Foam::foamVersion::api, error::functionName(), ioEndLineNumber(), ioFileName(), ioStartLineNumber(), messageStream::level, error::message(), Foam::nl, os(), Foam::foamVersion::patch, Foam::foamVersion::patched(), error::sourceFileLineNumber(), error::sourceFileName(), and messageStream::title().

Referenced by Foam::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IOerror() [1/3]

◆ IOerror() [2/3]

◆ IOerror() [3/3]

◆ ~IOerror()

Member Function Documentation

◆ ioFileName()

◆ ioStartLineNumber()

◆ ioEndLineNumber()

◆ operator()() [1/5]

◆ operator()() [2/5]

◆ operator()() [3/5]

◆ operator()() [4/5]

◆ operator()() [5/5]

◆ SafeFatalIOError()

◆ operator dictionary()

◆ exit()

◆ abort()

◆ write()