Fawkes API  Fawkes Development Version
firevision::SharedMemoryImageBufferMetaDataCollector Class Reference

Collect meta data about shared memory segments. More...

#include <>>

Inheritance diagram for firevision::SharedMemoryImageBufferMetaDataCollector:

Public Member Functions

 SharedMemoryImageBufferMetaDataCollector ()
 Constructor. More...
 
virtual ~SharedMemoryImageBufferMetaDataCollector ()
 Destructor. More...
 
virtual void print_header ()
 Print header of the table. More...
 
virtual void print_footer ()
 Print footer of the table. More...
 
virtual void print_no_segments ()
 Print this if no matching segment was found. More...
 
virtual void print_no_orphaned_segments ()
 Print this if no matching orphaned segment was found. More...
 
virtual void print_info (const fawkes::SharedMemoryHeader *header, int shm_id, int semaphore, unsigned int mem_size, const void *memptr)
 Print info about segment. More...
 
std::list< SharedMemoryImageBufferMetaData > & meta_data ()
 Get meta data. More...
 
- Public Member Functions inherited from fawkes::SharedMemoryLister
virtual ~SharedMemoryLister ()
 virtual destructor More...
 

Detailed Description

Collect meta data about shared memory segments.

Definition at line 155 of file shm_image.h.

Constructor & Destructor Documentation

◆ SharedMemoryImageBufferMetaDataCollector()

firevision::SharedMemoryImageBufferMetaDataCollector::SharedMemoryImageBufferMetaDataCollector ( )

Constructor.

Definition at line 1045 of file shm_image.cpp.

◆ ~SharedMemoryImageBufferMetaDataCollector()

firevision::SharedMemoryImageBufferMetaDataCollector::~SharedMemoryImageBufferMetaDataCollector ( )
virtual

Destructor.

Definition at line 1051 of file shm_image.cpp.

Member Function Documentation

◆ meta_data()

std::list<SharedMemoryImageBufferMetaData>& firevision::SharedMemoryImageBufferMetaDataCollector::meta_data ( )
inline

Get meta data.

Returns
image buffer meta data

Definition at line 174 of file shm_image.h.

◆ print_footer()

void firevision::SharedMemoryImageBufferMetaDataCollector::print_footer ( )
virtual

Print footer of the table.

This should fit on the terminal and thus have a width of at most 79 columns.

Implements fawkes::SharedMemoryLister.

Definition at line 1063 of file shm_image.cpp.

◆ print_header()

void firevision::SharedMemoryImageBufferMetaDataCollector::print_header ( )
virtual

Print header of the table.

This should fit on the terminal and thus have a width of at most 79 columns.

Implements fawkes::SharedMemoryLister.

Definition at line 1057 of file shm_image.cpp.

◆ print_info()

void firevision::SharedMemoryImageBufferMetaDataCollector::print_info ( const fawkes::SharedMemoryHeader header,
int  shm_id,
int  semaphore,
unsigned int  mem_size,
const void *  memptr 
)
virtual

Print info about segment.

This method is called for every matching shared memory segment. You should print a line of information (maybe more than one line if needed) about the segment.

Parameters
headerThe data-specific header
shm_idThe id of the shared memory segment
semaphoreSemaphore key of the given shared memory segment
mem_sizethe total memory size
memptrpointer to the data segment.

Implements fawkes::SharedMemoryLister.

Definition at line 1081 of file shm_image.cpp.

References firevision::SharedMemoryImageBufferHeader::colorspace(), firevision::SharedMemoryImageBufferHeader::frame_id(), firevision::SharedMemoryImageBufferHeader::height(), firevision::SharedMemoryImageBufferHeader::image_id(), and firevision::SharedMemoryImageBufferHeader::width().

◆ print_no_orphaned_segments()

void firevision::SharedMemoryImageBufferMetaDataCollector::print_no_orphaned_segments ( )
virtual

Print this if no matching orphaned segment was found.

Called by SharedMemory::erase_orphaned() if no matching segment could be found.

Implements fawkes::SharedMemoryLister.

Definition at line 1075 of file shm_image.cpp.

◆ print_no_segments()

void firevision::SharedMemoryImageBufferMetaDataCollector::print_no_segments ( )
virtual

Print this if no matching segment was found.

Called by SharedMemory if no matching segment could be found.

Implements fawkes::SharedMemoryLister.

Definition at line 1069 of file shm_image.cpp.


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