Commit 13e0d0e7 authored by thomas.forbriger's avatar thomas.forbriger
Browse files

[WP][DOC] (ticket10tsio): provide documentation in README

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.
parent b5c9d217
...@@ -5,18 +5,60 @@ libsioxx C++ time series file input/ouput ...@@ -5,18 +5,60 @@ libsioxx C++ time series file input/ouput
$Id$ $Id$
============================================================================ ============================================================================
The home of this software suite is Purpose
http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/trunk/src/libs/libtsioxx -------
This library is based on libtsxx which provides tools and utilities for time
series analysis and processing which refer to a given sampling interval of the
time series. libtsxx for this reason provides a ts::TimeSeries class template,
for objects storing sample values along with the sampling interval. The
current library (libtsioxx) inherits from this template to provide a
ts::sff::SFFTimeSeries class template for objects storing sample values along
with full qualified SFF headers (stored in ts::sff::TraceHeader objects) and
which are valid ts::TimeSeries objects at the same time.
For compilation instructions see README.1st in the root directory of the Based on ts::sff::SFFTimeSeries libtsioxx provides ts::sff::TraceVector with
tar-ball or publically inherits from the STL vector and provides an object to store
http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/docs/installation several ts::sff::SFFTimeSeries objects. This, together with
ts::sff::FileHeader, is used to compile the class template ts::sff::File,
which is able to store complete data files.
Please send bug reports and suggestions to Further libtsioxx provides input/output operators for the above mentioned
Thomas.Forbriger@kit.edu classes to be read from or written two libdatrwxx streams. Reading functions
wich provide a rangelist selection for input traces are provided too.
At the highest level of complexity, classes ts::sff::SFile and ts::sff::DFile
are provided together with file reading functions. These classes are meant to
store a complete set of data files as defined on the command line of
application programs together with file specific parameters. A set of such
files can be stored in ts::sff::TSFileList and ts::sff::TDFileList objects,
which basically are typedefs referring to the STL list container. File input
for these objects is supported for reading from libdatrwxx input streams.
Interfaces
----------
sfftimeseries.h
ts::sff::SFFTimeSeries class template
sfftsfile.h
ts::sff::File class template
inputoperators.h
outputoperators.h
input and output operators for ts::sff::SFFTimeSeries and ts::sff::File
SFFoutputoperators.h
deprecated output operators to SFF files (still provided for backward
compatibility)
cmdlinefiles.h
ts::sff::SFile and ts::sff::DFile and reading functions
Installation instructions Installation instructions
------------------------- -------------------------
For compilation instructions see README.1st in the root directory of the
tar-ball or
http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/docs/installation
The command make all will compile and install the binary executables The command make all will compile and install the binary executables
as well as the doxygen documentation. as well as the doxygen documentation.
...@@ -36,17 +78,22 @@ Dependencies: ...@@ -36,17 +78,22 @@ Dependencies:
doxygen (required to process source code documentation) doxygen (required to process source code documentation)
TFSoftware libraries required to compile the code: TFSoftware libraries required to compile the code:
? direct dependencies: direct dependencies:
? libtsxx, libaff, libsffxx, libtime, libgsexx libtsxx, libaff, libsffxx, libtime, libgsexx, libtfxx,
? indirect dependencies: libdatrwxx
? libseife, libdatrwxx indirect dependency:
libseife
Further non-standard libraries required to compile the code: Further non-standard libraries required to compile the code:
- the C++ standard template library (STL) - the C++ standard template library (STL)
Tests and examples are provided in subdirectory tests Source code documentation is provided through doxygen.
See target doxydoc in the Makefile.
Detailed documentation is provided through doxygen source code. See target The home of this software suite is
doxydoc in the Makefile. http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/trunk/src/libs/libtsioxx
Please send bug reports and suggestions to
Thomas.Forbriger@kit.edu
----- END OF README ----- ----- END OF README -----
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment