pwiz::data::Index Class Reference

generic interface for creating and using an index on a stream of serialized objects More...

#include <Index.hpp>

Inheritance diagram for pwiz::data::Index:

List of all members.

Classes
struct	Entry
	generic type identifying an indexed item by string id, ordinal index, and stream offset More...

Public Types
typedef boost::iostreams::stream_offset	stream_offset
typedef boost::shared_ptr< Entry >	EntryPtr

Public Member Functions
virtual void	create (std::vector< Entry > &entries)=0
	create the index from specified list of entries; the list is non-const because the index implementation may resort the list
virtual size_t	size () const =0
	returns the number of entries in the index
virtual EntryPtr	find (const std::string &id) const =0
	returns the entry for the specified string id, or null if the id is not in the index
virtual EntryPtr	find (size_t index) const =0
	returns the entry for the specified ordinal index, or null if the ordinal is not in the index
virtual	~Index ()

---

Detailed Description

generic interface for creating and using an index on a stream of serialized objects

Definition at line 39 of file Index.hpp.

---

Member Typedef Documentation

typedef boost::iostreams::stream_offset pwiz::data::Index::stream_offset

Definition at line 43 of file Index.hpp.

typedef boost::shared_ptr<Entry> pwiz::data::Index::EntryPtr

Definition at line 53 of file Index.hpp.

---

Constructor & Destructor Documentation

virtual pwiz::data::Index::~Index ( )

inlinevirtual

Definition at line 68 of file Index.hpp.

{}

---

Member Function Documentation

virtual void pwiz::data::Index::create ( std::vector< Entry > &  entries )

pure virtual

create the index from specified list of entries; the list is non-const because the index implementation may resort the list

Implemented in pwiz::data::BinaryIndexStream, and pwiz::data::MemoryIndex.

virtual size_t pwiz::data::Index::size ( ) const

pure virtual

returns the number of entries in the index

Implemented in pwiz::data::BinaryIndexStream, and pwiz::data::MemoryIndex.

virtual EntryPtr pwiz::data::Index::find ( const std::string &  id ) const

pure virtual

returns the entry for the specified string id, or null if the id is not in the index

Implemented in pwiz::data::BinaryIndexStream, and pwiz::data::MemoryIndex.

virtual EntryPtr pwiz::data::Index::find ( size_t  index ) const

pure virtual

returns the entry for the specified ordinal index, or null if the ordinal is not in the index

Implemented in pwiz::data::BinaryIndexStream, and pwiz::data::MemoryIndex.

---

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

• /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/common/Index.hpp