LRAUV  revA
FileLogReader Class Reference

Wraps around another LogReader to read LogEntries to a file. More...

#include <FileLogReader.h>

Inheritance diagram for FileLogReader:
Collaboration diagram for FileLogReader:

Public Member Functions

 FileLogReader (const Str &filebase, LogReader *logReader)
 Constructor. More...
 
virtual ~FileLogReader ()
 Destructor, closes file if open. More...
 
virtual bool valid (void)
 Is the LogReader valid? More...
 
virtual unsigned int read ()
 Read. More...
 
unsigned int getEntriesRead (void)
 Accessors. More...
 
Str nextFilename ()
 Uses nextFilenum_ to determine the next filename. More...
 
bool isReadable (void)
 Keep track of whether the stream is open. More...
 
- Public Member Functions inherited from LogReader
virtual ~LogReader ()
 Destructor. More...
 
virtual void setInStream (InStream &inStream)
 Sets the InStream. More...
 
virtual bool isValid ()
 Return true if logStream_ is available. More...
 

Static Public Member Functions

static void SetPriorityList (FlexArray< const char * > *priorityList)
 

Private Member Functions

 FileLogReader (const FileLogReader &old)
 
Str matchAndOpen (const Str &filename)
 

Private Attributes

Str filebase_
 Name of the file being read. More...
 
FILE * file_
 The input file handle. More...
 
FileInStream fileStream_
 The input file stream. More...
 
unsigned int entriesRead_
 Total entries read. More...
 
LogReaderlogReader_
 The LogReader that does the actual writing. More...
 
unsigned int nextFilenum_
 Number of the next split file. More...
 

Static Private Attributes

static FlexArray< const char * > * PriorityList_
 

Additional Inherited Members

- Protected Member Functions inherited from LogReader
 LogReader ()
 Protected constructor for pure virtual class. More...
 
 LogReader (InStream &inStream)
 Protected constructor for pure virtual class. More...
 
- Protected Attributes inherited from LogReader
InStreamlogStream_
 Stores an InStream. More...
 

Detailed Description

Wraps around another LogReader to read LogEntries to a file.

Designed around assumption that it always has a log file open, though it does keep track of whether the stream is open or close, which it uses to determine if it's valid.

Constructor & Destructor Documentation

FileLogReader::FileLogReader ( const Str filebase,
LogReader logReader 
)

Constructor.

Parameters
filebaseBase of name of file to read to
logReaderlogReader that provides input for file logging

References Str::cStr(), file_, filebase_, fileStream_, logReader_, matchAndOpen(), nextFilename(), FileInStream::setFile(), and LogReader::setInStream().

FileLogReader::~FileLogReader ( )
virtual

Destructor, closes file if open.

Destructor.

Closes file if open

References file_, and logReader_.

FileLogReader::FileLogReader ( const FileLogReader old)
private

Member Function Documentation

unsigned int FileLogReader::getEntriesRead ( void  )
inline

Accessors.

References entriesRead_.

bool FileLogReader::isReadable ( void  )
inline

Keep track of whether the stream is open.

References fileStream_, and FileInStream::isReadable().

Referenced by valid().

Str FileLogReader::matchAndOpen ( const Str filename)
private
Str FileLogReader::nextFilename ( )

Uses nextFilenum_ to determine the next filename.

References Str::cStr(), filebase_, and nextFilenum_.

Referenced by FileLogReader(), and read().

static void FileLogReader::SetPriorityList ( FlexArray< const char * > *  priorityList)
inlinestatic

References PriorityList_.

Referenced by Unserialize::Run().

virtual bool FileLogReader::valid ( void  )
inlinevirtual

Is the LogReader valid?

References isReadable().

Member Data Documentation

unsigned int FileLogReader::entriesRead_
private

Total entries read.

Referenced by getEntriesRead(), and read().

FILE* FileLogReader::file_
private

The input file handle.

Referenced by FileLogReader(), matchAndOpen(), read(), and ~FileLogReader().

Str FileLogReader::filebase_
private

Name of the file being read.

Referenced by FileLogReader(), and nextFilename().

FileInStream FileLogReader::fileStream_
private

The input file stream.

Referenced by FileLogReader(), isReadable(), and read().

LogReader* FileLogReader::logReader_
private

The LogReader that does the actual writing.

Referenced by FileLogReader(), read(), and ~FileLogReader().

unsigned int FileLogReader::nextFilenum_
private

Number of the next split file.

Referenced by nextFilename(), and read().

FlexArray< const char * > * FileLogReader::PriorityList_
staticprivate

Referenced by matchAndOpen(), and SetPriorityList().


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