orcalog::LogReader Class Reference

#include <logreader.h>

Inherited by orcalogfactory::CameraLogReader, orcalogfactory::DriveBicycleLogReader, orcalogfactory::GpsLogReader, orcalogfactory::LaserScanner2dLogReader, orcalogfactory::Localise2dLogReader, orcalogfactory::Localise3dLogReader, orcalogfactory::Odometry2dLogReader, orcalogfactory::Odometry3dLogReader, orcalogfactory::PathFollower2dLogReader, orcalogfactory::PowerLogReader, orcalogfactory::RangeScanner2dLogReader, and orcalogfactory::WifiLogReader.

List of all members.

Public Member Functions
void	init ()
	Opens data file (using openLogFile()).
int	logIndex () const
	An index into the log: we're currently pointing at the start of the logIndex_'th object.
void	setLogIndex (int index)
	Move about in the log.
virtual std::string	toString () const
Public Attributes
std::ifstream *	file_
	Handle to the input file.
Protected Member Functions
virtual void	openLogFile ()
virtual void	read ()=0
virtual void	initialised ()
	Hook for allowing calls on initialisation (i.e. when file has just opened).

---

Detailed Description

Handles a file which contains actual data (ie not the master file). All LogReaders inherit from this. Some file handling is done in the base class.

---

Member Function Documentation

void orcalog::LogReader::openLogFile

(

)

[protected, virtual]

This version correctly handles two standard log file formats: ice ; binary file ascii : ascii file This function does not catch exceptions which may result when opening a file. Derived classes which want to modify this behavior or need to handle other formats need to re-implement this function.

References file_, orcalog::openAsciiFileForReading(), orcalog::openBinaryFileForReading(), and orcaice::Context::tracer().

Referenced by init().

virtual void orcalog::LogReader::read

(

)

[protected, pure virtual]

Read a log item and chuck it away (base-class has to implement). Used for fast-forwarding through a file.

Referenced by setLogIndex().

std::string orcalog::LogReader::toString

(

)

const [virtual]

Returns a human-readable string. This is a reasonable default which can be over-ridden.

---

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

• logreader.h
• logreader.cpp