C++ mpi module for stochmagnet_main Package
Public Member Functions | Friends | List of all members
CORE_Exception Class Reference

this class describes the exceptions raised for CORE package More...

#include <CORE_Exception.h>

Inheritance diagram for CORE_Exception:
Inheritance graph
[legend]
Collaboration diagram for CORE_Exception:
Collaboration graph
[legend]

Public Member Functions

 CORE_Exception ()
 build an exception

 
 CORE_Exception (const tString &package)
 build an exception in package More...
 
 CORE_Exception (const tString &package, const tString &where, const tString &what)
 build an exeption in package, class and the explanation of error More...
 
 CORE_Exception (const tString &package, const tString &assertion, const tString &file, const tInteger &line, const tString &function)
 build an exeption in package, class and the explanation of error More...
 
tMemSize getMemorySize () const
 return the memory size of the class More...
 
tString getMessage () const
 return the message of the exception
 
virtual tString toString () const
 return the message of the exception
 

Friends

std::ostream & operator<< (std::ostream &out, const CORE_Exception &obj)
 print the class object More...
 

Detailed Description

this class describes the exceptions raised for CORE package

Constructor & Destructor Documentation

◆ CORE_Exception() [1/3]

CORE_Exception::CORE_Exception ( const tString &  package)

build an exception in package

Parameters
[in]package: name of the package

◆ CORE_Exception() [2/3]

CORE_Exception::CORE_Exception ( const tString &  package,
const tString &  where,
const tString &  what 
)

build an exeption in package, class and the explanation of error

Parameters
[in]package: name of the package
[in]where: method withe the error occurs
[in]what: cause of the error

◆ CORE_Exception() [3/3]

CORE_Exception::CORE_Exception ( const tString &  package,
const tString &  assertion,
const tString &  file,
const tInteger &  line,
const tString &  function 
)

build an exeption in package, class and the explanation of error

Parameters
[in]package: name of the package
[in]assertion: the assertion which has failed
[in]file: name of the file
[in]line: line of the error
[in]functionfunction name of the error

Member Function Documentation

◆ getMemorySize()

tMemSize CORE_Exception::getMemorySize ( ) const
inline

return the memory size of the class

Returns
the memory size of the class in bytes 1 octet = 1 byte 1 Ko = 1024 bytes 1 Mo = 1024 Ko 1 Go = 1024 Mo

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  out,
const CORE_Exception obj 
)
friend

print the class object

Parameters
out: output into printing
objobject to print
Returns
the output

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