Fawkes API  Fawkes Development Version
firevision::SharedMemoryLookupTableLister Class Reference

Shared memory lookup table lister. More...

#include <>>

Inheritance diagram for firevision::SharedMemoryLookupTableLister:

Public Member Functions

 SharedMemoryLookupTableLister ()
 Constructor. More...
 
virtual ~SharedMemoryLookupTableLister ()
 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...
 
- Public Member Functions inherited from fawkes::SharedMemoryLister
virtual ~SharedMemoryLister ()
 virtual destructor More...
 

Detailed Description

Shared memory lookup table lister.

Definition at line 97 of file shm_lut.h.

Constructor & Destructor Documentation

◆ SharedMemoryLookupTableLister()

firevision::SharedMemoryLookupTableLister::SharedMemoryLookupTableLister ( )

Constructor.

Definition at line 564 of file shm_lut.cpp.

◆ ~SharedMemoryLookupTableLister()

firevision::SharedMemoryLookupTableLister::~SharedMemoryLookupTableLister ( )
virtual

Destructor.

Definition at line 570 of file shm_lut.cpp.

Member Function Documentation

◆ print_footer()

void firevision::SharedMemoryLookupTableLister::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 590 of file shm_lut.cpp.

◆ print_header()

void firevision::SharedMemoryLookupTableLister::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 576 of file shm_lut.cpp.

◆ print_info()

void firevision::SharedMemoryLookupTableLister::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 611 of file shm_lut.cpp.

References firevision::SharedMemoryLookupTableHeader::height(), firevision::SharedMemoryLookupTableHeader::lut_id(), and firevision::SharedMemoryLookupTableHeader::width().

◆ print_no_orphaned_segments()

void firevision::SharedMemoryLookupTableLister::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 605 of file shm_lut.cpp.

◆ print_no_segments()

void firevision::SharedMemoryLookupTableLister::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 596 of file shm_lut.cpp.


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