Fawkes API  Fawkes Development Version
firevision::ColormapFileBlock Class Reference

FireVision data file block for colormap files. More...

#include <>>

Inheritance diagram for firevision::ColormapFileBlock:

Public Member Functions

 ColormapFileBlock (unsigned int type, size_t data_size, void *spec_header, size_t spec_header_size)
 Constructor. More...
 
 ColormapFileBlock (unsigned int type, size_t data_size, size_t spec_header_size)
 Constructor. More...
 
 ColormapFileBlock (unsigned int type, size_t data_size)
 Constructor. More...
 
virtual ~ColormapFileBlock ()
 Virtual empty destructor. More...
 
- Public Member Functions inherited from firevision::FireVisionDataFileBlock
 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

 ColormapFileBlock (FireVisionDataFileBlock *block)
 Shallow copy constructor. More...
 
- Protected Member Functions inherited from firevision::FireVisionDataFileBlock
void set_spec_header (void *spec_header, size_t spec_header_size)
 Set content-specific header. More...
 

Additional Inherited Members

- Protected Attributes inherited from firevision::FireVisionDataFileBlock
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...
 

Detailed Description

FireVision data file block for colormap files.

Author
Tim Niemueller

Definition at line 36 of file cmfile_block.h.

Constructor & Destructor Documentation

◆ ColormapFileBlock() [1/4]

firevision::ColormapFileBlock::ColormapFileBlock ( unsigned int  type,
size_t  data_size,
void *  spec_header,
size_t  spec_header_size 
)

Constructor.

Parameters
typeblock type, content specific
data_sizesize of the data segment
spec_headercontent-specific header
spec_header_sizesize of spec_header in bytes

Definition at line 43 of file cmfile_block.cpp.

◆ ColormapFileBlock() [2/4]

firevision::ColormapFileBlock::ColormapFileBlock ( unsigned int  type,
size_t  data_size,
size_t  spec_header_size 
)

Constructor.

Parameters
typeblock type, content specific
data_sizesize of the data segment
spec_header_sizesize of spec_header in bytes

Definition at line 55 of file cmfile_block.cpp.

◆ ColormapFileBlock() [3/4]

firevision::ColormapFileBlock::ColormapFileBlock ( unsigned int  type,
size_t  data_size 
)

Constructor.

Parameters
typeblock type, content specific
data_sizesize of the data segment

Definition at line 66 of file cmfile_block.cpp.

◆ ~ColormapFileBlock()

firevision::ColormapFileBlock::~ColormapFileBlock ( )
virtual

Virtual empty destructor.

Definition at line 85 of file cmfile_block.cpp.

◆ ColormapFileBlock() [4/4]

firevision::ColormapFileBlock::ColormapFileBlock ( FireVisionDataFileBlock block)
protected

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.

Parameters
blockblock to copy

Definition at line 78 of file cmfile_block.cpp.


The documentation for this class was generated from the following files: