FileUtil Documentation

Reference for the FileUtil package

FileUtil provides basic functions for file input/output, extending the standard C++ libraries. The package provides special support for reading tagged values from configuration files.

The usage of configuration files can significantly improve the flexibility of Shark based software. There are two different levels of configuration file support, which are illustrated by the examples provided with the library.

A very simple and easy to use functionality is provided by the methods scanFrom and scanFrom_strict, which search a text based configuration file for a tagged value. The template based implementation ensures type safety. This set of functions is completely sufficient for simple configuration settings.

For more complicated configuration files with lots of parameters FileUtil provides the Params class. It serves as a base class of an application specific configuration class holding all parameters in a single central object.