Commit 631e192a authored by thomas.forbriger's avatar thomas.forbriger Committed by thomas.forbriger
Browse files

proceeding with documentation

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: 2409
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent b1e23dc0
......@@ -3,7 +3,7 @@
----------------------------------------------------------------------------
$Id: README,v 1.5 2007-09-29 17:44:59 tforb Exp $
$Id: README,v 1.6 2007-10-02 07:32:56 tforb Exp $
\author Thomas Forbriger
\date 16/03/2002
......@@ -55,9 +55,14 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
This library supports reading and writing of waveforms as defined by the
%GSE2.1 standard (Provisional %GSE2.1 Formats and Protocols, May 1997).
The library defines a modul GSE2::waveform. This modul containes classes
(TWID2, TSTA2) that hold %GSE2 format elements. Further it contains
functions to read and write waveform data in subformats CM6.
The library defines a module GSE2::waveform. This module containes classes
(TWID2, TCHK2) that hold %GSE2 format elements and can handle their input
and output to data files. Further it contains functions to read and write
waveform data in subformat CM6.
The library has the primary purpose to supply the CM6 time series
input/output layer for reading and writing SFF data. But it is designed to
be supplemented with other %GSE2.1 elements and functionality in the future.
\section using Using the library
Please have a look at Makefile to find installation instructions.
......
// this is <README>
// ----------------------------------------------------------------------------
// $Id: README,v 1.10 2007-01-31 07:42:03 tforb Exp $
// $Id: README,v 1.11 2007-10-02 07:32:56 tforb Exp $
//
// Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt)
//
......@@ -18,13 +18,15 @@
\since November 2002
\date November 2002
\version V1.0
$Id: README,v 1.10 2007-01-31 07:42:03 tforb Exp $
$Id: README,v 1.11 2007-10-02 07:32:56 tforb Exp $
\section main_aims Aims
This library contains smaller and independent sets of classes and modules.
They should provide stable and reliable interfaces and sematics. Some of
them will be copied from libclass which was more for experimenting purposes.
The modules provide handling of commandline options and arguments, I/O byte
swapping, I/O for Fortran binary files, error handling, and more.
\section main_modules Modules
......
......@@ -17,7 +17,7 @@
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = "libtime++ library: handle time and time intervals"
PROJECT_NAME = "libtime++: Date and time calculation"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
......
/* this is <libtime++.h>
* ----------------------------------------------------------------------------
*
* $Id: libtime++.h,v 2.18 2006-04-28 09:15:19 tforb Exp $
* $Id: libtime++.h,v 2.19 2007-10-02 07:32:57 tforb Exp $
*
* Copyright (c) by Thomas Forbriger (IfG Stuttgart)
*
......@@ -49,7 +49,7 @@
#ifndef TF_LIBTIME_H_
#define TF_LIBTIME_H_ \
"$Id: libtime++.h,v 2.18 2006-04-28 09:15:19 tforb Exp $"
"$Id: libtime++.h,v 2.19 2007-10-02 07:32:57 tforb Exp $"
#include <string>
#include "libtime.h"
......@@ -58,6 +58,35 @@ using std::string;
namespace libtime {
/*! \mainpage
*
* \author Thomas Forbriger
* \date $Date: 2007-10-02 07:32:57 $
* \since 1997, 2000
* \version $Id: libtime++.h,v 2.19 2007-10-02 07:32:57 tforb Exp $
*
* This library supports numerical operations for dates and times with integer
* precision down to microseconds.
* Time comes in two different flavours:
* -# absolute time (like today at 10 o'clock) as supported by
* libtime::TAbsoluteTime
* -# relative times (like the time span between now and christmas) as
* supported by libtime::TRelativeTime
*
* The modules in the library support operations like:
* - calculate the number of samples in a time window
* - calculate the expected time and date for the first sample in the next
* data block
* - calculate the time gap between two data blocks
* - calculate the the index of the sample nearest to a given time
* - calculate the residual time between a given time and the nearest sample
*
* The library provides interfaces in Fortran, C, C++.
* Unfortunately handling of leapseconds is not yet supported.
*
* \sa example++.cc, tests/libtime++.cc
*/
/*!
* TBaseClassTime
* ==============
......
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