Public Member Functions | List of all members
IBSimu Class Reference

Main class for IBSimu. More...

#include <ibsimu.hpp>

Public Member Functions

 IBSimu ()
 Default constructor.
 
 ~IBSimu ()
 Default destructor.
 
std::ostream & set_vout (std::ostream &vout)
 Set verbose output to stream vout.
 
std::ostream & set_vout (const std::string &filename)
 Set verbose output to file filename.
 
std::ostream & vout (void)
 Get a reference to verbose output stream.
 
bool vout_is_cout ()
 Return if verbose output stream is std::cout.
 
void set_verbose_output (int level)
 Set verbosity level.
 
int get_verbose_output (void)
 Get verbosity level.
 
void set_thread_count (int threadcount)
 Set the number of threads used for calculation.
 
int get_thread_count (void)
 Get the number of threads used for calculation.
 
void halt (void)
 Halt execution.
 

Detailed Description

Main class for IBSimu.

Used to store global settings. One instance of the class is initialized globally with the name ibsimu.

Constructor & Destructor Documentation

IBSimu::IBSimu ( )

Default constructor.

IBSimu::~IBSimu ( )

Default destructor.

Member Function Documentation

int IBSimu::get_thread_count ( void  )
inline

Get the number of threads used for calculation.

int IBSimu::get_verbose_output ( void  )
inline

Get verbosity level.

void IBSimu::halt ( void  )

Halt execution.

This function is called by the error handler in case of SIGTERM.

void IBSimu::set_thread_count ( int  threadcount)

Set the number of threads used for calculation.

void IBSimu::set_verbose_output ( int  level)

Set verbosity level.

std::ostream& IBSimu::set_vout ( std::ostream &  vout)

Set verbose output to stream vout.

Returns a reference to the old output stream.

std::ostream& IBSimu::set_vout ( const std::string &  filename)

Set verbose output to file filename.

Returns a reference to the old output stream. If the output stream is redefined, the file is kept open in the background. IBSimu can only have one output stream opened at time with this function. The file is closed when the IBSimu object is destructed.

std::ostream& IBSimu::vout ( void  )

Get a reference to verbose output stream.

bool IBSimu::vout_is_cout ( )

Return if verbose output stream is std::cout.


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