Fawkes API  Fawkes Development Version
fvfile_block.h
1 
2 /***************************************************************************
3  * fvfile_block.h - FireVision file block
4  *
5  * Created: Fri Mar 28 11:52:45 2008
6  * Copyright 2008 Tim Niemueller [www.niemueller.de]
7  *
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version. A runtime exception applies to
14  * this software (see LICENSE.GPL_WRE file mentioned below for details).
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Library General Public License for more details.
20  *
21  * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22  */
23 
24 #ifndef __FIREVISION_FVUTILS_FILEFORMAT_FVFILE_BLOCK_H_
25 #define __FIREVISION_FVUTILS_FILEFORMAT_FVFILE_BLOCK_H_
26 
27 #include <fvutils/fileformat/fvff.h>
28 #include <cstddef>
29 
30 namespace firevision {
31 #if 0 /* just to make Emacs auto-indent happy */
32 }
33 #endif
34 
36 {
37  public:
38  FireVisionDataFileBlock(unsigned int type, size_t data_size,
39  void *spec_header, size_t spec_header_size);
40  FireVisionDataFileBlock(unsigned int type, size_t data_size,
41  size_t spec_header_size);
42  FireVisionDataFileBlock(unsigned int type, size_t data_size);
44  virtual ~FireVisionDataFileBlock();
45 
46  unsigned int type() const;
47  void * block_memptr() const;
48  size_t block_size() const;
49  void * data_ptr() const;
50  size_t data_size() const;
51 
52  protected:
53  void set_spec_header(void *spec_header, size_t spec_header_size);
54 
55  void *_data;
56  size_t _data_size;
57  void *_spec_header;
58 
59  private:
60  void constructor(unsigned int type, size_t data_size,
61  void *spec_header, size_t spec_header_size);
62 
63  fvff_block_header_t *__block_header;
64  void *__block_memptr;
65  size_t __block_size;
66  bool __block_owner;
67 
68  size_t __spec_header_size;
69 };
70 
71 } // end namespace firevision
72 
73 #endif
unsigned int type() const
Get block type.
void * _data
Pointer to the internal data segment.
Definition: fvfile_block.h:55
void * block_memptr() const
Pointer to the whole block.
FireVision File Format data block.
Definition: fvfile_block.h:35
void set_spec_header(void *spec_header, size_t spec_header_size)
Set content-specific header.
void * _spec_header
Pointer to the content specific block header.
Definition: fvfile_block.h:57
void * data_ptr() const
Get data pointer.
virtual ~FireVisionDataFileBlock()
Destructor.
size_t block_size() const
Size of blocks.
size_t _data_size
Size of _data in bytes.
Definition: fvfile_block.h:56
size_t data_size() const
Size of data chunk.
FireVisionDataFileBlock(unsigned int type, size_t data_size, void *spec_header, size_t spec_header_size)
Constructor.