readtsdata.h 3.09 KB
Newer Older
thomas.forbriger's avatar
thomas.forbriger committed
1
/*! \file readtsdata.h
thomas.forbriger's avatar
GPL    
thomas.forbriger committed
2
3
 * \brief read waveform data through the interface provided by libdatreadxx 
 * (prototypes)
thomas.forbriger's avatar
thomas.forbriger committed
4
5
6
 * 
 * ----------------------------------------------------------------------------
 * 
thomas.forbriger's avatar
thomas.forbriger committed
7
 * $Id: readtsdata.h,v 1.3 2007-02-09 08:50:21 tforb Exp $
thomas.forbriger's avatar
thomas.forbriger committed
8
9
10
 * \author Thomas Forbriger
 * \date 31/01/2007
 * 
thomas.forbriger's avatar
GPL    
thomas.forbriger committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 * read waveform data through the interface provided by libdatreadxx 
 * (prototypes)
 *
 * ----
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version. 
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ----
thomas.forbriger's avatar
thomas.forbriger committed
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 * 
 * Copyright (c) 2007 by Thomas Forbriger (BFO Schiltach) 
 * 
 * REVISIONS and CHANGES 
 *  - 31/01/2007   V1.0   Thomas Forbriger
 * 
 * ============================================================================
 */

// include guard
#ifndef TF_READTSDATA_H_VERSION

#define TF_READTSDATA_H_VERSION \
  "TF_READTSDATA_H   V1.0   "
#define TF_READTSDATA_H_CVSID \
thomas.forbriger's avatar
thomas.forbriger committed
44
  "$Id: readtsdata.h,v 1.3 2007-02-09 08:50:21 tforb Exp $"
thomas.forbriger's avatar
thomas.forbriger committed
45

thomas.forbriger's avatar
thomas.forbriger committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/*! \defgroup group_readtsdata Reading of time series data.
 * \brief Read a complete set of time series including the selection of
 *   traces.
 *
 * The module is presented in namespace tfxx::tsio.
 *
 */

/*! \brief Interface provided through readtsdata.h
 *
 * \defgroup readtsdata_h Interface provided through readtsdata.h
 * 
 * \ingroup group_readtsdata
 */
namespace tfxx {

/*! \namespace tfxx::tsio
 * \brief Namespace containing all components of module readtsdata.
 * \ingroup group_readtsdata, readtsdata_h
 */
  namespace tsio {

    //! type of trace selection list
    typedef tfxx::RangeList<int> Ttracelist;

    //! type of trace selection key
    typedef const char[] Ttracelistkey;

    //! structure to contain file data together with command line arguments
    struct File {
      // command line arguments
      tfxx::cmdline::Filename arguments;
      // container to hold samples
      ts::sff::File<C> data;
    }; // struct File
    
    //! read complete SFF file
    readSFF(const std::string& filename);

    //! read complete SFF file with trace selection
    readSFF(const std::string& filename,
            const Ttracelist& selection);

    //! read complete SFF file with trace selection
    readSFF(const tfxx::cmdline::Filename& filename,
            const Tracelistkey="t");

    //! read complete list of SFF files with trace selection
    readSFF(const tfxx::cmdline::Tparsed& flist,
            const Tracelistkey="t");


  } // namespace tsio
thomas.forbriger's avatar
thomas.forbriger committed
99

thomas.forbriger's avatar
thomas.forbriger committed
100
} // namespace tfxx
thomas.forbriger's avatar
thomas.forbriger committed
101
102
103
104

#endif // TF_READTSDATA_H_VERSION (includeguard)

/* ----- END OF readtsdata.h ----- */