[WP][DOC] (ticket10tsio): document gross structure of modules
This is a legacy commit from before 2015-03-01. It may be incomplete as well as inconsistent. See COPYING.legacy and README.history for details. The gross structure of the modules is documented. I intend to reorganize the namespaces accordingly. Probably filenames should be considered for modification too. Form doxygen.txt: Two modules are provided: in sffheaders.h: SFF Timeseries I/O This module provides three submodules: A set of classes to handle complete files Interface to libdatrwxx Interface to libsffxx in readtsdata.h: Reading of time series data. The first adds SFF specific headers to the TimeSeries class template provided by libtsxx. It adds further structures to hold data from complete time series data files. For input and output of complete files, appropriate i/o operators are provided for libdatrwxx streams. Trace selection is supported. The latter module adds further data to the file classes provided by the first modules. Additionally it provides reading functions (not writing functions) which in the end support the reading of all time series data files provided on the command line together with all file specific flags and parameters and selecting traces.
Showing with 110 additions and 43 deletions