LOW_exception Class Reference

Base class for all exception of this library. More...

#include <LOW_exception.h>

Inheritance diagram for LOW_exception:

[legend]Collaboration diagram for LOW_exception:

[legend]List of all members.

Public Member Functions
	LOW_exception ()
	Default constructor.
	LOW_exception (const std::string inMsg, const std::string inFile, const int inLine)
	Constructor.
	LOW_exception (const int inErrNum, const std::string inMsg, const std::string inFile, const int inLine)
	Constructor for OS errors.
virtual	~LOW_exception ()
	Destructor.
virtual void	logException (const std::string inPrefix="")
	Log the exception via LOW_helper_msglog::printError().
Static Public Member Functions
void	setLogOnCreation (const bool inLogOnCreation)
	Set wether exceptions should be logged automatically when created.
const bool	getLogOnCreation ()
	Get wether exceptions are logged automatically when created.
Public Attributes
const int	errNum
	OS error number.
const std::string	message
	Descriptive message.
const std::string	file
	File from which exception was thrown.
const int	line
	Line number where exception was thrown.
Static Protected Attributes
LOW_thread_rwlock *	__staticSyncRwlockSingleton = 0
LOW_platformMiscFactory::threadIdent_t	__writeLockHolder = 0
bool	logOnCreation = false
	Indicates wether exception should be logged automatically when the are created.

---

Detailed Description

Base class for all exception of this library.

This class is thread-safe.

Author:

Harald Roelle

Definition at line 46 of file LOW_exception.h.

---

Constructor & Destructor Documentation

LOW_exception::LOW_exception (   )

Default constructor. Definition at line 42 of file LOW_exception.cpp.

LOW_exception::LOW_exception (  const std::string  inMsg, const std::string  inFile, const int  inLine )

Constructor. Parameters: inMsg  Message describing the exception. inFile  File from which exception is thrown. inLine  Line number where exception is thrown. Definition at line 49 of file LOW_exception.cpp. References logException(), and logOnCreation.

LOW_exception::LOW_exception (  const int  inErrNum, const std::string  inMsg, const std::string  inFile, const int  inLine )

Constructor for OS errors. The textual OS description (perror) is added automatically when exception is logged. Parameters: inErrNum  OS error number. inMsg  Message describing the exception. inFile  File from which exception is thrown. inLine  Line number where exception is thrown. Definition at line 60 of file LOW_exception.cpp. References logException(), and logOnCreation.

LOW_exception::~LOW_exception (   )  [virtual]

Destructor. Definition at line 71 of file LOW_exception.cpp.

---

Member Function Documentation

const bool LOW_exception::getLogOnCreation (   )  [static]

Get wether exceptions are logged automatically when created. Returns: Wether exceptions are logged automatically. Definition at line 89 of file LOW_exception.cpp. References __LOW_SYNCHRONIZE_STATIC_READ__, and logOnCreation.

void LOW_exception::logException (  const std::string  inPrefix = ""  )  [virtual]

Log the exception via LOW_helper_msglog::printError(). Parameters: inPrefix  Prefix to prepend to the log message. Definition at line 102 of file LOW_exception.cpp. References errNum, file, line, message, LOW_helper_msglog::printError(), and LOW_helper_msglog::printPerror(). Referenced by LOW_exception().

void LOW_exception::setLogOnCreation (  const bool  inLogOnCreation  )  [static]

Set wether exceptions should be logged automatically when created. Parameters: inLogOnCreation  Wether exceptions should be logged automatically. Definition at line 81 of file LOW_exception.cpp. References __LOW_SYNCHRONIZE_STATIC_WRITE__, and logOnCreation.

---

Member Data Documentation

LOW_thread_rwlock * LOW_exception::__staticSyncRwlockSingleton = 0 [static, protected]

Definition at line 32 of file LOW_exception.cpp.

LOW_platformMiscFactory::threadIdent_t LOW_exception::__writeLockHolder = 0 [static, protected]

Definition at line 32 of file LOW_exception.cpp.

const int LOW_exception::errNum

OS error number. Definition at line 56 of file LOW_exception.h. Referenced by logException().

const std::string LOW_exception::file

File from which exception was thrown. Definition at line 58 of file LOW_exception.h. Referenced by logException().

const int LOW_exception::line

Line number where exception was thrown. Definition at line 59 of file LOW_exception.h. Referenced by logException().

bool LOW_exception::logOnCreation = false [static, protected]

Indicates wether exception should be logged automatically when the are created. Definition at line 34 of file LOW_exception.cpp. Referenced by getLogOnCreation(), LOW_exception(), and setLogOnCreation().

const std::string LOW_exception::message

Descriptive message. Definition at line 57 of file LOW_exception.h. Referenced by logException().

---

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

• LOW_exception.h
• LOW_exception.cpp

---