bpp::SequenceFileIndex Class Reference

Index to retrieve Sequence in a file. More...

#include <Bpp/Seq/Io/SequenceFileIndex.h>

Inheritance diagram for bpp::SequenceFileIndex:

Public Member Functions
virtual	~SequenceFileIndex ()
virtual void	build (const std::string &path)=0 throw (Exception)
	Build the index given a path to the file. More...
virtual std::streampos	getSequencePosition (const std::string &id) const =0 throw (Exception)
	Get the position of a Sequence given its ID. More...
virtual size_t	getNumberOfSequences () const =0 throw (Exception)
	Get the number of sequences. More...

Detailed Description

Index to retrieve Sequence in a file.

This class is designed to build an in-memory index of a Sequence file in order to retrieve Sequence given its ID.

Author

Sylvain Gaillard

Definition at line 55 of file SequenceFileIndex.h.

Constructor & Destructor Documentation

~SequenceFileIndex()

virtual bpp::SequenceFileIndex::~SequenceFileIndex ( )

inlinevirtual

Definition at line 57 of file SequenceFileIndex.h.

Member Function Documentation

build()

virtual void bpp::SequenceFileIndex::build ( const std::string &  path ) throw ( Exception )

pure virtual

Build the index given a path to the file.

Implemented in bpp::Fasta::FileIndex.

getNumberOfSequences()

virtual size_t bpp::SequenceFileIndex::getNumberOfSequences ( ) const throw ( Exception )

pure virtual

Get the number of sequences.

Implemented in bpp::Fasta::FileIndex.

getSequencePosition()

virtual std::streampos bpp::SequenceFileIndex::getSequencePosition ( const std::string &  id ) const throw ( Exception )

pure virtual

Get the position of a Sequence given its ID.

Implemented in bpp::Fasta::FileIndex.

---

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

• Bpp/Seq/Io/SequenceFileIndex.h