DATRW++ library: seismic data I/O with multiple formats
properties.h
Go to the documentation of this file.
1 /*! \file properties.h
2  * \brief describe data properties (prototypes)
3  *
4  * \ingroup group_properties
5  * ----------------------------------------------------------------------------
6  *
7  * \author Thomas Forbriger
8  * \date 14/02/2011
9  *
10  * describe data properties (prototypes)
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 
36 // include guard
37 #ifndef DATRW_PROPERTIES_H_VERSION
38 
39 #define DATRW_PROPERTIES_H_VERSION \
40  "DATRW_PROPERTIES_H V1.0 "
41 
42 namespace datrw {
43 
44  /*! \brief Handle information on file type, stream and file properties.
45  *
46  * \defgroup group_properties Internal utility: Handle information on file type, stream and file
47  * properties
48  */
49 
50  /*! \brief properties base class.
51  *
52  * An object of this type will be returned by the member function properties
53  * in input and output stream classes. This way the interface to query
54  * properties will always remain constant. Only the fields provided by the
55  * properties class may grow in the future and not necessarily has to be the
56  * same for all types of streams.
57  */
58  class Properties {
59  }; // class Properties
60 
61 } // namespace datrw
62 
63 #endif // DATRW_PROPERTIES_H_VERSION (includeguard)
64 
65 /* ----- END OF properties.h ----- */
properties base class.
Definition: properties.h:58
Root namespace of library.
Definition: aalibdatrwxx.cc:16