Commit 1a15e9b2 authored by thomas.forbriger's avatar thomas.forbriger Committed by thomas.forbriger
Browse files

short documentation of streams

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.


SVN Path:     http://gpitrsvn.gpi.uni-karlsruhe.de/repos/TFSoftware/trunk
SVN Revision: 1864
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent 1c078e76
# this is <Makefile>
# ----------------------------------------------------------------------------
# $Id: Makefile,v 1.13 2005-07-06 14:11:13 tforb Exp $
# $Id: Makefile,v 1.14 2005-07-18 10:03:44 tforb Exp $
#
# Copyright (c) 2003 by Thomas Forbriger (BFO Schiltach)
#
......@@ -50,8 +50,8 @@ clean: ;
# ------------
LIBSRC=sffxx.cc wid2compare.cc wid2inrange.cc wid2isample.cc \
wid2lastsample.cc sffistream.cc sffostream.cc srcesynref.cc
INCSRC=sffxx.h sffostream.h sffistream.h
wid2lastsample.cc sffostream.cc srcesynref.cc
INCSRC=sffxx.h sffostream.h
-include $(patsubst %.cc,%.d,$(LIBSRC))
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: README,v 1.1 2003-12-30 17:18:52 tforb Exp $
* $Id: README,v 1.2 2005-07-18 10:03:45 tforb Exp $
* \author Thomas Forbriger
* \date 25/12/2003
*
......@@ -47,6 +47,7 @@ read data files written with libsffxx to Fortran code.
- \ref sec_main_header_classes
- \ref sec_main_waveform_io
- \ref sec_main_usage
- \ref sec_main_streams
- \ref sec_main_reading
- \ref sec_main_writing
......@@ -152,6 +153,20 @@ read data files written with libsffxx to Fortran code.
Examples for the usage of the library modules can be found in sfftest.cc
\subsection sec_main_streams I/O streams for SFF data
There are input and output streams available for SFF data.
The output stream class template sff::SFFostream is available within this
library through sffostream.h
Using this output stream, you must always write the time series itself first!
Header lines are written to the stream after the time series has been
written.
A stream for reading SFF data is available within
<a href="../../libdatreadxx/html/index.html">libdatreadxx.a</a>.
A short tutorial for reading and writing SFF data with streams is given
there too.
\subsection sec_main_reading Reading from an SFF data file
First open a file input stream.
......
Supports Markdown
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