Commit ff8abdc2 authored by thomas.forbriger's avatar thomas.forbriger

libtsioxx [WP][DOC]: give account of new file contents

parent a9cd6d11
......@@ -34,30 +34,51 @@ for these objects is supported for reading from libdatrwxx input streams.
Interfaces
----------
tsioxx.h
Main interface to the library, loads all modules.
traceheader.h
Definition of ts::sff::TraceHeader
sfftimeseries.h
declare ts::sff::TraceHeader and ts::sff::SFFTimeSeries class template
Definition of ts::sff::SFFTimeSeries<C> class template
This essentially is a ts::TimeSeries with ts::sff::TraceHeader
fileheader.h
Definition of ts::sff::FileHeader
tracevector.h
Definition of ts::sff::TraceVector<C> class template
sfftsfile.h
declare ts::sff::FileHeader, ts::sff::TraceVector<C>, and
ts::sff::File<C> class template
Definition of ts::sff::File<C> class template
to store contents of a complete time series data file
sfftsfileread.h
Definition of read member function for ts::sff::File<C>
operators.h
inputoperators.h
libdatrwxx input operators for ts::sff::TraceHeader, ts::sff::FileHeader,
and ts::sff::File<C>
outputoperators.h
input and output operators for ts::sff::SFFTimeSeries and ts::sff::File
operators.h loads inputoperators.h and outputoperators.h
libdatrwxx output operators for objects of libtsioxx
SFFoutputoperators.h
deprecated output operators to SFF files (still provided for backward
compatibility)
operators.h
Load input and output operators
cmdlinefiles.h
ts::sff::SFile and ts::sff::DFile and reading functions
These functions take command line parameters as assembled by modules in
tfxx::cmdline as provided in tfxx/xcmdline.h The functions all are called
either ts::sff::readSSFF (returns single precision ts::sff::SFile) or
ts::sff::readDSFF (returns double precision ts::sff::DFile)
definition of classes ts::sff::SFile and ts::sff::DFile to store time series
data in single and double precision, respectively
definition of typedef for ts::sff::TSFileList and ts::sff::TDFileList
which are STL lists of ts::sff::SFile and ts::sff::DFile, respectively
Declaration of ts::sff::readSSFF (returns single precision ts::sff::SFile) or
ts::sff::readDSFF (returns double precision ts::sff::DFile) reading
functions. They read an entire set of files and return data in appropriate
objects. Data selection is supported by command line parameters being
assembled in modules from namespace tfxx::cmdline as provided in
tfxx/xcmdline.h
Implementation
--------------
......@@ -67,10 +88,10 @@ cmdlinefiles.cc
inputoperators.cc
implements input operators for ts::sff::FileHeader and ts::sff::TraceHeader
sfftimeseries.cc
traceheader.cc
implements member functions of ts::sff::TraceHeader
sfftsfile.cc
fileheader.cc
implements member functions of ts::sff::FileHeader
Installation instructions
......
......@@ -25,6 +25,10 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* ----
*
* The code in this file must be kept in its own header file, because this
* compilation units has to load inputoperators.h which in turn loads
* sfftsfile.h
*
* REVISIONS and CHANGES
* - 02/04/2019 V1.0 Thomas Forbriger
*
......
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