firevision::SharedMemoryLookupTableLister Class Reference

Shared memory lookup table lister. More...

#include <fvutils/ipc/shm_lut.h>

Inheritance diagram for firevision::SharedMemoryLookupTableLister:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 SharedMemoryLookupTableLister ()
 Constructor.
virtual ~SharedMemoryLookupTableLister ()
 Destructor.
virtual void print_header ()
 Print header of the table.
virtual void print_footer ()
 Print footer of the table.
virtual void print_no_segments ()
 Print this if no matching segment was found.
virtual void print_no_orphaned_segments ()
 Print this if no matching orphaned segment was found.
virtual void print_info (const fawkes::SharedMemoryHeader *header, int shm_id, int semaphore, unsigned int mem_size, const void *memptr)
 Print info about segment.

Detailed Description

Shared memory lookup table lister.

Definition at line 97 of file shm_lut.h.


Constructor & Destructor Documentation

firevision::SharedMemoryLookupTableLister::SharedMemoryLookupTableLister (  ) 

Constructor.

Definition at line 564 of file shm_lut.cpp.

firevision::SharedMemoryLookupTableLister::~SharedMemoryLookupTableLister (  )  [virtual]

Destructor.

Definition at line 570 of file shm_lut.cpp.


Member Function Documentation

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.

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.

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:
header The data-specific header
shm_id The id of the shared memory segment
semaphore Semaphore key of the given shared memory segment
mem_size the total memory size
memptr pointer 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().

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.

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:

Generated on 1 Mar 2011 for Fawkes API by  doxygen 1.6.1