Fawkes API
Fawkes Development Version
|
FireVision File Format data block. More...
#include <>>
Public Member Functions | |
FireVisionDataFileBlock (unsigned int type, size_t data_size, void *spec_header, size_t spec_header_size) | |
Constructor. More... | |
FireVisionDataFileBlock (unsigned int type, size_t data_size, size_t spec_header_size) | |
Constructor. More... | |
FireVisionDataFileBlock (unsigned int type, size_t data_size) | |
Constructor. More... | |
FireVisionDataFileBlock (FireVisionDataFileBlock *block) | |
Shallow copy constructor. More... | |
virtual | ~FireVisionDataFileBlock () |
Destructor. More... | |
unsigned int | type () const |
Get block type. More... | |
void * | block_memptr () const |
Pointer to the whole block. More... | |
size_t | block_size () const |
Size of blocks. More... | |
void * | data_ptr () const |
Get data pointer. More... | |
size_t | data_size () const |
Size of data chunk. More... | |
Protected Member Functions | |
void | set_spec_header (void *spec_header, size_t spec_header_size) |
Set content-specific header. More... | |
Protected Attributes | |
void * | _data |
Pointer to the internal data segment. More... | |
size_t | _data_size |
Size of _data in bytes. More... | |
void * | _spec_header |
Pointer to the content specific block header. More... | |
FireVision File Format data block.
This class describes one data block inside a FVFF file.
Definition at line 35 of file fvfile_block.h.
firevision::FireVisionDataFileBlock::FireVisionDataFileBlock | ( | unsigned int | type, |
size_t | data_size, | ||
void * | spec_header, | ||
size_t | spec_header_size | ||
) |
Constructor.
type | block type, content specific |
data_size | size of the data segment |
spec_header | content-specific header |
spec_header_size | size of spec_header in bytes |
Definition at line 59 of file fvfile_block.cpp.
firevision::FireVisionDataFileBlock::FireVisionDataFileBlock | ( | unsigned int | type, |
size_t | data_size, | ||
size_t | spec_header_size | ||
) |
Constructor.
type | block type, content specific |
data_size | size of the data segment |
spec_header_size | a specific header of the given size is created internally |
Definition at line 71 of file fvfile_block.cpp.
firevision::FireVisionDataFileBlock::FireVisionDataFileBlock | ( | unsigned int | type, |
size_t | data_size | ||
) |
Constructor.
Specific header is assumed to be unused.
type | block type, content specific |
data_size | size of the data segment |
Definition at line 83 of file fvfile_block.cpp.
firevision::FireVisionDataFileBlock::FireVisionDataFileBlock | ( | FireVisionDataFileBlock * | block | ) |
Shallow copy constructor.
This creates a shallow copy of the given block. "Shallow" means that the data is not copied but referenced. This instance is only valid as long as the original instance still exists.
block | block to copy |
Definition at line 95 of file fvfile_block.cpp.
References _data, _data_size, _spec_header, data_size(), firevision::_fvff_block_header_t::size, firevision::_fvff_block_header_t::spec_head_size, type(), and firevision::_fvff_block_header_t::type.
|
virtual |
Destructor.
Definition at line 173 of file fvfile_block.cpp.
void * firevision::FireVisionDataFileBlock::block_memptr | ( | ) | const |
Pointer to the whole block.
Definition at line 195 of file fvfile_block.cpp.
size_t firevision::FireVisionDataFileBlock::block_size | ( | ) | const |
void * firevision::FireVisionDataFileBlock::data_ptr | ( | ) | const |
Get data pointer.
Definition at line 215 of file fvfile_block.cpp.
References _data.
Referenced by firevision::Histogram::Histogram(), and firevision::FireVisionDataFile::read().
size_t firevision::FireVisionDataFileBlock::data_size | ( | ) | const |
Size of data chunk.
Definition at line 225 of file fvfile_block.cpp.
References _data_size.
Referenced by FireVisionDataFileBlock().
|
protected |
Set content-specific header.
If necessary this re-creates internal buffers. To avoid this use the three-parameter ctor to have it account for the expected header size.
spec_header | content-specific header |
spec_header_size | size of spec_header in bytes |
Definition at line 145 of file fvfile_block.cpp.
References _data, _data_size, _spec_header, and firevision::_fvff_block_header_t::spec_head_size.
unsigned int firevision::FireVisionDataFileBlock::type | ( | ) | const |
Get block type.
Definition at line 185 of file fvfile_block.cpp.
References firevision::_fvff_block_header_t::type.
Referenced by FireVisionDataFileBlock(), and firevision::TriclopsStereoProcessor::verify_rectification_lut().
|
protected |
Pointer to the internal data segment.
Never free or modify the pointer, but only deal with the data it points to.
Definition at line 55 of file fvfile_block.h.
Referenced by firevision::ColormapFileYuvBlock::ColormapFileYuvBlock(), data_ptr(), FireVisionDataFileBlock(), firevision::HistogramBlock::HistogramBlock(), firevision::RectificationLutInfoBlock::RectificationLutInfoBlock(), firevision::HistogramBlock::set_data(), and set_spec_header().
|
protected |
Size of _data in bytes.
Definition at line 56 of file fvfile_block.h.
Referenced by firevision::ColormapFileYuvBlock::ColormapFileYuvBlock(), data_size(), FireVisionDataFileBlock(), firevision::RectificationInfoBlock::RectificationInfoBlock(), firevision::HistogramBlock::reset(), firevision::HistogramBlock::set_data(), and set_spec_header().
|
protected |
Pointer to the content specific block header.
Never free or modify the pointer, but only deal with the data it points to.
Definition at line 57 of file fvfile_block.h.
Referenced by firevision::ColormapFileYuvBlock::ColormapFileYuvBlock(), FireVisionDataFileBlock(), firevision::HistogramBlock::HistogramBlock(), firevision::RectificationInfoBlock::RectificationInfoBlock(), and set_spec_header().