lobot::MetlogList Class Reference

An object to help keep track of which metrics log should be loaded next. More...

#include <Robots/LoBot/metlog/LoMetlogList.H>

Collaboration diagram for lobot::MetlogList:
Collaboration graph
[legend]

List of all members.

Classes

struct  eol

Public Member Functions

 MetlogList (const std::vector< std::string > &metlog_list)
std::string next () const

Detailed Description

An object to help keep track of which metrics log should be loaded next.

This class implements a thread-safe interface for lobot::LoaderThread objects so they can figure out which metrics log should be loaded and parsed next. When all the metlogs have been processed, further attempts at retrieving the name of the next one for loading will result in an exception. The loader threads can use the exception as a signal to wind up their work.

Definition at line 89 of file LoMetlogList.H.


Constructor & Destructor Documentation

lobot::MetlogList::MetlogList ( const std::vector< std::string > &  metlog_list  ) 

When this object is created, it should be passed the list of names of metrics logs that have to be loaded.

NOTE: It is important that the loader threads not yet be active when this class is instantiated.

Definition at line 53 of file LoMetlogList.C.


Member Function Documentation

std::string lobot::MetlogList::next (  )  const

This method retrieves the next name on the list. When all the names have been retrieved, it will throw an end-of-line exception to indicate to the loader threads that it's time for them to wind up their business.

Definition at line 59 of file LoMetlogList.C.


The documentation for this class was generated from the following files:
Generated on Sun May 8 08:44:29 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3