Fawkes API  Fawkes Development Version
firevision::_fvff_header_t Struct Reference

Header for a FireVision file format file. More...

#include <fvff.h>

List of all members.

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.


Member Data Documentation

char firevision::_fvff_header_t::comment[FVFF_COMMENT_SIZE]

optional comment

Definition at line 66 of file fvff.h.

creation unix timestamp, seconds

Definition at line 64 of file fvff.h.

creation unix timestamp, useconds

Definition at line 65 of file fvff.h.

endianess of the file, 0 means little endian, 1 means big endian

Definition at line 60 of file fvff.h.

magic token

Definition at line 58 of file fvff.h.

number of rectification info blocks in this file

Definition at line 62 of file fvff.h.

reserved for future use

Definition at line 61 of file fvff.h.

data specific header size

Definition at line 63 of file fvff.h.

version of the data file, this header defines version 1

Definition at line 59 of file fvff.h.


The documentation for this struct was generated from the following file: