6.2 ABA_ABACUSROOT Class Reference

base class of all other classes of ABACUS

#include <abacusroot.h>

Inheritance diagram for ABA_ABACUSROOT::

Public Types

• enum EXITCODES { Ok, Fatal }

  This enumeration defines the codes used be the function exit().

Public Member Functions

• virtual ~ABA_ABACUSROOT ()
• virtual void exit (enum EXITCODES code) const

  terminates the program and returns code to the environment from which the program was called.

• const char *onOff (bool value)

  converts a boolean variable to the strings "on" and "off".

• double fracPart (double x) const

6.2.1 Detailed Description

base class of all other classes of ABACUS

Definition at line 81 of file abacusroot.h.

6.2.2 Member Enumeration Documentation

6.2.2.1 enum ABA_ABACUSROOT::EXITCODES

This enumeration defines the codes used be the function exit().

Parameters:

Ok

The program terminates without error.

Fatal

A severe error occurred leading to an immediate termination of the program.

Enumerator:

Ok

Fatal

Definition at line 95 of file abacusroot.h.

6.2.3 Constructor & Destructor Documentation

6.2.3.1 virtual ABA_ABACUSROOT::~ABA_ABACUSROOT () [virtual]

The destructor is only implemented since it should be virtual function.

6.2.4 Member Function Documentation

6.2.4.1 virtual void ABA_ABACUSROOT::exit (enum EXITCODES code) const [virtual]

terminates the program and returns code to the environment from which the program was called.

We overload the function exit() that in a debugger a break point can be easily set within this function in order to investigate the error. We also observed that for some reason it can be impossible to set a break point within a template. Here this function exit() was quite helpful during the debugging process.

Exception handling could substitute many calls to the function exit(). However, in version 2.6.3 of the GNU / compiler only a prototypical implementation of exception handling is available. As soon as a the GNU compiler provides a stable implementation of exception handling we will use this technique in future releases of this software.

Parameters:

code

The exit code given to the environment.

6.2.4.2 const char* ABA_ABACUSROOT::onOff (bool value)

converts a boolean variable to the strings "on" and "off".

Returns:

"on" if value is true

"off" otherwise

Parameters:

value

The boolean variable being converted.

6.2.4.3 double ABA_ABACUSROOT::fracPart (double x) const

Returns:

The absolute value of the fractional part of the value x. E.g., it holds fracPart(2.33) == 0.33 and fracPart(-1.77) == 0.77.

Parameters:

x

The value of which the fractional part is computed.

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

• Include/abacus/abacusroot.h