pwiz::proteome::ProteinListCache Class Reference

adds a level of flexible MRU caching to a ProteinList processor chain More...

#include <ProteinListCache.hpp>

Inheritance diagram for pwiz::proteome::ProteinListCache:

List of all members.

Public Types
typedef std::pair< size_t, ProteinPtr >	KeyValuePair
	a cache mapping spectrum indices to ProteinPtrs
typedef pwiz::util::mru_list < KeyValuePair, boost::multi_index::member_offset < KeyValuePair, size_t, first_offset > >	CacheType

Public Member Functions
	BOOST_STATIC_CONSTANT (unsigned, first_offset=offsetof(KeyValuePair, first))
	ProteinListCache (const ProteinListPtr &inner, ProteinListCacheMode cacheMode, size_t cacheSize)
virtual ProteinPtr	protein (size_t index, bool getSequence=true) const
	returns the requested spectrum which may or may not be cached depending on the current cache mode
virtual size_t	find (const std::string &id) const
void	setMode (ProteinListCacheMode mode)
	set the caching mode note: if the new mode is different than the current mode, the cache will be cleared
ProteinListCacheMode	mode () const
	get the current caching mode
const CacheType &	cache () const
	get a const-reference to the cache
Public Member Functions inherited from pwiz::proteome::ProteinListWrapper
	ProteinListWrapper (const ProteinListPtr &inner)
virtual size_t	size () const
Public Member Functions inherited from pwiz::proteome::ProteinList
virtual bool	empty () const
virtual IndexList	findKeyword (const std::string &keyword, bool caseSensitive=true) const
virtual	~ProteinList ()

Private Member Functions
	ProteinListCache (ProteinListCache &)
ProteinListCache &	operator= (ProteinListCache &)

Private Attributes
CacheType	cache_
ProteinListCacheMode	mode_

Additional Inherited Members
Protected Attributes inherited from pwiz::proteome::ProteinListWrapper
ProteinListPtr	inner_

---

Detailed Description

adds a level of flexible MRU caching to a ProteinList processor chain

Definition at line 45 of file ProteinListCache.hpp.

---

Member Typedef Documentation

typedef std::pair<size_t, ProteinPtr> pwiz::proteome::ProteinListCache::KeyValuePair

a cache mapping spectrum indices to ProteinPtrs

Definition at line 50 of file ProteinListCache.hpp.

typedef pwiz::util::mru_list<KeyValuePair, boost::multi_index::member_offset<KeyValuePair, size_t, first_offset> > pwiz::proteome::ProteinListCache::CacheType

Definition at line 52 of file ProteinListCache.hpp.

---

Constructor & Destructor Documentation

pwiz::proteome::ProteinListCache::ProteinListCache	(	const ProteinListPtr &	inner,
		ProteinListCacheMode	cacheMode,
		size_t	cacheSize
	)

pwiz::proteome::ProteinListCache::ProteinListCache ( ProteinListCache &  )

private

---

Member Function Documentation

pwiz::proteome::ProteinListCache::BOOST_STATIC_CONSTANT	(	unsigned	,
		first_offset	= offsetof(KeyValuePair, first)
	)

virtual ProteinPtr pwiz::proteome::ProteinListCache::protein ( size_t  index, bool  getSequence = true  ) const

virtual

returns the requested spectrum which may or may not be cached depending on the current cache mode

Reimplemented from pwiz::proteome::ProteinListWrapper.

Referenced by testModeMetaDataAndSequence(), testModeMetaDataOnly(), and testModeOff().

virtual size_t pwiz::proteome::ProteinListCache::find ( const std::string &  id ) const

virtual

Reimplemented from pwiz::proteome::ProteinList.

void pwiz::proteome::ProteinListCache::setMode

(

ProteinListCacheMode

mode

)

set the caching mode note: if the new mode is different than the current mode, the cache will be cleared

ProteinListCacheMode pwiz::proteome::ProteinListCache::mode

(

)

const

get the current caching mode

const CacheType& pwiz::proteome::ProteinListCache::cache ( ) const

inline

get a const-reference to the cache

Definition at line 72 of file ProteinListCache.hpp.

Referenced by testModeMetaDataAndSequence(), testModeMetaDataOnly(), and testModeOff().

{return cache_;}

ProteinListCache& pwiz::proteome::ProteinListCache::operator= ( ProteinListCache &  )

private

---

Member Data Documentation

CacheType pwiz::proteome::ProteinListCache::cache_

mutableprivate

Definition at line 77 of file ProteinListCache.hpp.

ProteinListCacheMode pwiz::proteome::ProteinListCache::mode_

private

Definition at line 78 of file ProteinListCache.hpp.

---

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

• /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/proteome/ProteinListCache.hpp