A.I.M.S


bckheader.h
Go to the documentation of this file.
1 /* This software and supporting documentation are distributed by
2  * Institut Federatif de Recherche 49
3  * CEA/NeuroSpin, Batiment 145,
4  * 91191 Gif-sur-Yvette cedex
5  * France
6  *
7  * This software is governed by the CeCILL-B license under
8  * French law and abiding by the rules of distribution of free software.
9  * You can use, modify and/or redistribute the software under the
10  * terms of the CeCILL-B license as circulated by CEA, CNRS
11  * and INRIA at the following URL "http://www.cecill.info".
12  *
13  * As a counterpart to the access to the source code and rights to copy,
14  * modify and redistribute granted by the license, users are provided only
15  * with a limited warranty and the software's author, the holder of the
16  * economic rights, and the successive licensors have only limited
17  * liability.
18  *
19  * In this respect, the user's attention is drawn to the risks associated
20  * with loading, using, modifying and/or developing or reproducing the
21  * software by the user in light of its specific status of free software,
22  * that may mean that it is complicated to manipulate, and that also
23  * therefore means that it is reserved for developers and experienced
24  * professionals having in-depth computer knowledge. Users are therefore
25  * encouraged to load and test the software's suitability as regards their
26  * requirements in conditions enabling the security of their systems and/or
27  * data to be ensured and, more generally, to use and operate it in the
28  * same conditions as regards security.
29  *
30  * The fact that you are presently reading this means that you have had
31  * knowledge of the CeCILL-B license and that you accept its terms.
32  */
33 
34 /*
35  * Bucket header class
36  */
37 #ifndef AIMS_IO_BCKHEADER_H
38 #define AIMS_IO_BCKHEADER_H
39 
40 
42 #include <aims/data/pheader.h>
43 #include <aims/def/general.h>
44 
45 
46 namespace aims
47 {
48 
52  {
53  public:
54  BckHeader( const std::string& name, const std::string & type = "UNKNOWN",
55  float sizex = 1, float sizey = 1, float sizez = 1,
56  float sizet = 1, uint byteorder = AIMS_MAGIC_NUMBER,
57  const std::string & openmode = "binar" );
58  virtual ~BckHeader() { }
59 
60  std::string name() const { return _name; }
61  std::string dataType() const { return _type; }
62 
63  virtual int dimX() const { return( 0 ); }
64  virtual int dimY() const { return( 0 ); }
65  virtual int dimZ() const { return( 0 ); }
66  virtual int dimT() const { return( _ntime ); }
67  virtual float sizeX() const;
68  virtual float sizeY() const;
69  virtual float sizeZ() const;
70  virtual float sizeT() const;
71 
72  uint byteOrder() const { return _byteOrder; }
73  std::string openMode() const { return _openMode; }
74 
75  std::string filename() const;
76  virtual std::string extension() const { return( ".bck" ); }
77  virtual std::set<std::string> extensions() const;
78 
79  void read( uint32_t* offset = 0 );
80  void write();
81 
82  private:
83  std::string _name;
84  std::string _type;
85  int _ntime;
86  uint _byteOrder;
87  std::string _openMode;
88  };
89 
90 }
91 
92 
93 #endif
std::string openMode() const
Definition: bckheader.h:73
Descriptor class for the .bck BUCKET file format header.
Definition: bckheader.h:51
Attributed python-like header, stores all needed information about an object, currently used for volu...
Definition: pheader.h:51
virtual int dimZ() const
Definition: bckheader.h:65
virtual int dimT() const
Definition: bckheader.h:66
std::string name() const
Definition: bckheader.h:60
#define AIMSDATA_API
uint byteOrder() const
Definition: bckheader.h:72
virtual int dimY() const
Definition: bckheader.h:64
virtual ~BckHeader()
Definition: bckheader.h:58
std::string dataType() const
Definition: bckheader.h:61
virtual std::string extension() const
standard file format extension of specialized headers
Definition: bckheader.h:76
#define AIMS_MAGIC_NUMBER
Definition: general.h:51
virtual int dimX() const
Definition: bckheader.h:63
unsigned int uint