Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
header.hh
1 // Copyright (C) 2008, 2009, 2011 EPITA Research and Development
2 // Laboratory (LRDE)
3 //
4 // This file is part of Olena.
5 //
6 // Olena is free software: you can redistribute it and/or modify it under
7 // the terms of the GNU General Public License as published by the Free
8 // Software Foundation, version 2 of the License.
9 //
10 // Olena is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
17 //
18 // As a special exception, you may use this file as part of a free
19 // software project without restriction. Specifically, if other files
20 // instantiate templates or use macros or inline functions from this
21 // file, or you compile this file and link it with other files to produce
22 // an executable, this file does not by itself cause the resulting
23 // executable to be covered by the GNU General Public License. This
24 // exception does not however invalidate any other reasons why the
25 // executable file might be covered by the GNU General Public License.
26 
27 #ifndef MLN_IO_FLD_HEADER_HH
28 # define MLN_IO_FLD_HEADER_HH
29 
30 namespace mln
31 {
32 
33  namespace io
34  {
35 
36  namespace fld
37  {
38 
39 
40  struct data_type { enum E { UNKNOWN, BYTE, SHORT, INTEGER, FLOAT, DOUBLE }; };
41  struct field_type { enum E { UNKNOWN, UNIFORM, RECTILINEAR, IRREGULAR }; };
42 
46  struct fld_header
47  {
48  int ndim; // The number of computational dimensions in the field.
49  int* dim; // The dimension size of each axis.
50  int nspace; // The number of physical coordinates per field element.
51  int veclen; // The number of data values for each field element.
52  data_type::E data; // The primitive data type of all the data values.
53  field_type::E field; // The field type.
54  float* min_ext; // The minimum coordinate value that any member data point occupies in space.
55  float* max_ext; // The maximum coordinate value that any member data point occupies in space.
56  // std::vector<std::string> label; // Not handled.
57  // std::vector<std::string> unit; // Not handled.
58  // void* min_val; // The minimum data value in the field. (Not used)
59  // void* max_val; // The maximum data value in the field. (Not used)
60  // struct {...} variable; // Not handled.
61  // struct {...} coord; // Not handled.
62 
63  fld_header();
64  ~fld_header();
65  };
66 
67 
68 # ifndef MLN_INCLUDE_ONLY
69 
70  inline
71  fld_header::fld_header()
72  : ndim (-1),
73  dim (0),
74  nspace (-1),
75  veclen (-1),
76  data (data_type::UNKNOWN),
77  field (field_type::UNKNOWN)
78  {
79  }
80 
81  inline
82  fld_header::~fld_header()
83  {
84  delete [] dim;
85  delete [] max_ext;
86  delete [] min_ext;
87  }
88 
89 # endif // ! MLN_INCLUDE_ONLY
90 
91  } // end of namespace mln::io::fld
92 
93  } // end of namespace mln::io
94 
95 } // end of namespace mln
96 
97 #endif // !MLN_IO_FLD_HEADER_HH