Fawkes API  Fawkes Development Version
fawkes::SharedMemoryLister Class Referenceabstract

Format list output for shared memory segments. More...

#include <shm_lister.h>

Inheritance diagram for fawkes::SharedMemoryLister:

Public Member Functions

virtual ~SharedMemoryLister ()
 virtual destructor More...
 
virtual void print_header ()=0
 Print header of the table. More...
 
virtual void print_footer ()=0
 Print footer of the table. More...
 
virtual void print_no_segments ()=0
 Print this if no matching segment was found. More...
 
virtual void print_no_orphaned_segments ()=0
 Print this if no matching orphaned segment was found. More...
 
virtual void print_info (const SharedMemoryHeader *header, int shm_id, int semaphore, unsigned int mem_size, const void *memptr)=0
 Print info about segment. More...
 

Detailed Description

Format list output for shared memory segments.

Implement this function specific to your SharedMemoryHeader to printout data about the shared memory segments.

Author
Tim Niemueller

Definition at line 43 of file shm_lister.h.

Constructor & Destructor Documentation

◆ ~SharedMemoryLister()

virtual fawkes::SharedMemoryLister::~SharedMemoryLister ( )
inlinevirtual

virtual destructor

Definition at line 47 of file shm_lister.h.

Member Function Documentation

◆ print_footer()

virtual void fawkes::SharedMemoryLister::print_footer ( )
pure virtual

Print footer of the table.

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

Implemented in firevision::SharedMemoryImageBufferMetaDataCollector, firevision::SharedMemoryImageBufferLister, firevision::SharedMemoryLookupTableLister, and fawkes::BlackBoardSharedMemoryLister.

◆ print_header()

virtual void fawkes::SharedMemoryLister::print_header ( )
pure virtual

Print header of the table.

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

Implemented in firevision::SharedMemoryImageBufferMetaDataCollector, firevision::SharedMemoryImageBufferLister, firevision::SharedMemoryLookupTableLister, and fawkes::BlackBoardSharedMemoryLister.

◆ print_info()

virtual void fawkes::SharedMemoryLister::print_info ( const SharedMemoryHeader header,
int  shm_id,
int  semaphore,
unsigned int  mem_size,
const void *  memptr 
)
pure 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.

Implemented in fawkes::BlackBoardSharedMemoryLister, firevision::SharedMemoryImageBufferMetaDataCollector, firevision::SharedMemoryImageBufferLister, and firevision::SharedMemoryLookupTableLister.

◆ print_no_orphaned_segments()

virtual void fawkes::SharedMemoryLister::print_no_orphaned_segments ( )
pure virtual

◆ print_no_segments()

virtual void fawkes::SharedMemoryLister::print_no_segments ( )
pure virtual

Print this if no matching segment was found.

Called by SharedMemory if no matching segment could be found.

Implemented in firevision::SharedMemoryImageBufferMetaDataCollector, firevision::SharedMemoryImageBufferLister, firevision::SharedMemoryLookupTableLister, and fawkes::BlackBoardSharedMemoryLister.


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