DATRW++ library: seismic data I/O with multiple formats
properties.cc
Go to the documentation of this file.
1 /*! \file properties.cc
2  * \brief describe data properties (implementation)
3  *
4  * \ingroup group_properties
5  * ----------------------------------------------------------------------------
6  *
7  * \author Thomas Forbriger
8  * \date 14/02/2011
9  *
10  * describe data properties (implementation)
11  *
12  * Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach)
13  *
14  * ----
15  * This program is free software; you can redistribute it and/or modify
16  * it under the terms of the GNU General Public License as published by
17  * the Free Software Foundation; either version 2 of the License, or
18  * (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28  * ----
29  *
30  * REVISIONS and CHANGES
31  * - 14/02/2011 V1.0 Thomas Forbriger
32  *
33  * ============================================================================
34  */
35 #define DATRW_PROPERTIES_CC_VERSION \
36  "DATRW_PROPERTIES_CC V1.0 "
37 
38 #include <datrwxx/properties.h>
39 
40 namespace datrw {
41 
42 } // namespace datrw
43 
44 /*======================================================================*/
45 
46 /*! \page page_properties Format, File, data, and stream properties
47  *
48  * There are properties of different category which should be presented to the
49  * user:
50  *
51  * -# Format properties:
52  * Are properties of a specific data format like
53  * - The file is binary or ASCII
54  * - Each file can contain multiple traces
55  * -# File properties:
56  * Are properties of a specific file and are not specific to the format.
57  * For example data can be encoded differently in PDAS data files.
58  * -# Stream properties:
59  * Are properties of a specific stream.
60  * This can be a specifc normalization mode for SFF data used upon
61  * output.
62  * -# Trace properties:
63  * Are properties which can vary from trace to trace within one file.
64  * -# Data properties:
65  * Are properties of a data representation used internally (are samples
66  * stored as integers or floats in single or double precision).
67  *
68  * Funtions should be provided, which return structures which present these
69  * properties.
70  * Using structures makes this interface quite flexible.
71  * These structures can be extended in the future without the need to change
72  * the query interface in all strteams.
73  * For this reason it is also necessary to define meaningful default values
74  * (which could also mean "undefined") such that the structure is filled with
75  * reasonable return values also in cases where the data module query
76  * interface is not explicitely made aware of this parameter.
77  *
78  * Structures should contain each other hierarchically, such that the query
79  * for trace properties also return properties of the file.
80  * However, a query for format properties will not be able to return
81  * information on a specific traces.
82  *
83  * \sa \ref page_data_types
84  */
85 
86 /* ----- END OF properties.cc ----- */
datrw
Root namespace of library.
Definition: aalibdatrwxx.cc:16
properties.h
describe data properties (prototypes)