_fvff_header_t Struct Reference
Header for a FireVision file format file. More...
#include <fvff.h>
Public Attributes | |
| uint16_t | magic_token |
| magic token | |
| uint16_t | version: 4 |
| version of the data file, this header defines version 1 | |
| uint16_t | endianess: 1 |
| endianess of the file, 0 means little endian, 1 means big endian | |
| uint16_t | reserved: 11 |
| reserved for future use | |
| uint16_t | num_blocks |
| number of rectification info blocks in this file | |
| uint32_t | spec_head_size |
| data specific header size | |
| uint64_t | created_sec |
| creation unix timestamp, seconds | |
| uint64_t | created_usec |
| creation unix timestamp, useconds | |
| char | comment [FVFF_COMMENT_SIZE] |
| optional comment | |
Detailed Description
Header for a FireVision file format file.The header defines the basic parameters needed to correctly interpret the following file contents.
The header defines a magic by which a rectinfo can be identified. This is defined by the actual content of the file. The version is stored as a sequential number. This version has to be changed whenever either the header or the file data format changes. The version is set by the concrete data implementation. The file defines the endianess of the supplied data. There are several reserved bits that may be used later to store flags. The field num_blocks define how many info blocks there are in this file.
Directly following the header is the content specific header. It has to be exactly the size given in spec_head_size.
Definition at line 52 of file fvff.h.
Member Data Documentation
| char _fvff_header_t::comment[FVFF_COMMENT_SIZE] |
optional comment
Definition at line 61 of file fvff.h.
Referenced by FireVisionDataFile::read(), and FireVisionDataFile::set_comment().
| uint64_t _fvff_header_t::created_sec |
creation unix timestamp, seconds
Definition at line 59 of file fvff.h.
Referenced by FireVisionDataFile::write().
| uint64_t _fvff_header_t::created_usec |
creation unix timestamp, useconds
Definition at line 60 of file fvff.h.
Referenced by FireVisionDataFile::write().
| uint16_t _fvff_header_t::endianess |
endianess of the file, 0 means little endian, 1 means big endian
Definition at line 55 of file fvff.h.
Referenced by FireVisionDataFile::clear(), FireVisionDataFile::is_big_endian(), FireVisionDataFile::is_little_endian(), and FireVisionDataFile::read().
| uint16_t _fvff_header_t::magic_token |
magic token
Definition at line 53 of file fvff.h.
Referenced by FireVisionDataFile::clear(), FireVisionDataFile::magic_token(), and FireVisionDataFile::read().
| uint16_t _fvff_header_t::num_blocks |
number of rectification info blocks in this file
Definition at line 57 of file fvff.h.
Referenced by FireVisionDataFile::clear(), FireVisionDataFile::read(), and FireVisionDataFile::write().
| uint16_t _fvff_header_t::reserved |
| uint32_t _fvff_header_t::spec_head_size |
data specific header size
Definition at line 58 of file fvff.h.
Referenced by FireVisionDataFile::read(), and FireVisionDataFile::write().
| uint16_t _fvff_header_t::version |
version of the data file, this header defines version 1
Definition at line 54 of file fvff.h.
Referenced by FireVisionDataFile::clear(), FireVisionDataFile::read(), and FireVisionDataFile::version().
The documentation for this struct was generated from the following file:
- src/firevision/fvutils/fileformat/fvff.h

