General Index for reading. More...

#include <AutoIndex.h>

Inheritance diagram for AutoIndex:

Public Member Functions
virtual void	open (const stdString &filename, ReadWrite readwrite=ReadOnly)
	Open an index. More...

virtual void	close ()
	Close the index. More...

virtual Result *	addChannel (const stdString &channel)
	Add a channel to the index. More...

virtual Result *	findChannel (const stdString &channel)
	Obtain the RTree for a channel. More...

virtual NameIterator *	iterator ()
	Get NameIterator, located on first channel. More...

Public Member Functions inherited from Index
	Index ()
	Constructor.

virtual	~Index ()
	Destructor.

const std::string &	getFilename ()
	Get the basename. More...

const std::string &	getDirectory ()
	Get the directory. More...

const stdString &	getFullName ()

Additional Inherited Members
Public Types inherited from Index
enum	ReadWrite { ReadOnly, ReadAndWrite }
	Modes used for open.

Detailed Description

General Index for reading.

Index which automatically picks ListIndex or IndexFile when reading, based on looking at the first few bytes in the index file.

Member Function Documentation

virtual Result* AutoIndex::addChannel ( const stdString & channel )

virtual

Add a channel to the index.

A channel has to be added before data blocks get defined for the channel. When channel is already in index, existing tree gets returned.

Exceptions

GenericException on internal error.

Implements Index.

virtual void AutoIndex::close ( )

virtual

Close the index.

Implements Index.

virtual Result* AutoIndex::findChannel ( const stdString & channel )

virtual

Obtain the RTree for a channel.

Directory is set to the path/directory of the index, which together with the data block in the RTree will then lead to the actual data files.

Exceptions

GenericException on internal error.

Implements Index.

virtual NameIterator* AutoIndex::iterator ( )

virtual

Get NameIterator, located on first channel.

Exceptions

GenericException on error.

Implements Index.

virtual

Open an index.

Exceptions

GenericException on error (file not found, wrong file format, ...).

Implements Index.

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

/home/malitsky/projects/epics-archiver/sourceforge/trunk/ea4-cpp/include/common/storage/AutoIndex.h