Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions
firevision::SharedMemoryImageBufferLister Class Reference

Shared memory image buffer lister. More...

#include <>>

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

List of all members.

Public Member Functions

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

Detailed Description

Shared memory image buffer lister.

Definition at line 117 of file shm_image.h.

Constructor & Destructor Documentation

firevision::SharedMemoryImageBufferLister::SharedMemoryImageBufferLister ( )

Constructor.

Definition at line 910 of file shm_image.cpp.

firevision::SharedMemoryImageBufferLister::~SharedMemoryImageBufferLister ( )
virtual

Destructor.

Definition at line 916 of file shm_image.cpp.

Member Function Documentation

void firevision::SharedMemoryImageBufferLister::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 936 of file shm_image.cpp.

void firevision::SharedMemoryImageBufferLister::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 922 of file shm_image.cpp.

void firevision::SharedMemoryImageBufferLister::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 956 of file shm_image.cpp.

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

void firevision::SharedMemoryImageBufferLister::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 949 of file shm_image.cpp.

void firevision::SharedMemoryImageBufferLister::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 942 of file shm_image.cpp.

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