adds a level of flexible MRU caching to a SpectrumList processor chain More...
#include <SpectrumListCache.hpp>
Inheritance diagram for pwiz::msdata::SpectrumListCache:
Public Types | |
| typedef std::pair< size_t, SpectrumPtr > | KeyValuePair |
| a cache mapping spectrum indices to SpectrumPtrs More... | |
| typedef MemoryMRUCache< KeyValuePair, boost::multi_index::member_offset< KeyValuePair, size_t, first_offset > > | CacheType |
Public Member Functions | |
| BOOST_STATIC_CONSTANT (unsigned, first_offset=offsetof(KeyValuePair, first)) | |
| SpectrumListCache (const SpectrumListPtr &inner, MemoryMRUCacheMode cacheMode, size_t cacheSize) | |
| virtual SpectrumPtr | spectrum (size_t index, bool getBinaryData=false) const |
| returns the requested spectrum which may or may not be cached depending on the current cache mode More... | |
| CacheType & | spectrumCache () |
| returns a reference to the cache, to enable clearing it or changing the mode More... | |
| const CacheType & | spectrumCache () const |
| returns a const-reference to the cache More... | |
 Public Member Functions inherited from pwiz::msdata::SpectrumListWrapper | |
| SpectrumListWrapper (const SpectrumListPtr &inner) | |
| virtual size_t | size () const |
| returns the number of spectra More... | |
| virtual bool | empty () const |
| returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL) More... | |
| virtual const SpectrumIdentity & | spectrumIdentity (size_t index) const |
| access to a spectrum index More... | |
| virtual SpectrumPtr | spectrum (size_t index, DetailLevel detailLevel) const |
| retrieve a spectrum by index More... | |
| virtual const boost::shared_ptr< const DataProcessing > | dataProcessingPtr () const |
| returns the data processing affecting spectra retrieved through this interface More... | |
| SpectrumListPtr | inner () const |
| SpectrumListPtr | innermost () const |
| Public Member Functions inherited from pwiz::msdata::SpectrumList | |
| virtual size_t | find (const std::string &id) const |
| find id in the spectrum index (returns size() on failure) More... | |
| virtual size_t | findAbbreviated (const std::string &abbreviatedId, char delimiter= '.') const |
| find an abbreviated id (e.g. "1.1.123.2" for "sample=1 period=1 cycle=123 experiment=2") in the spectrum index (returns size() on failure) More... | |
| virtual IndexList | findNameValue (const std::string &name, const std::string &value) const |
| find all spectrum indexes with specified name/value pair More... | |
| virtual IndexList | findSpotID (const std::string &spotID) const |
| find all spectrum indexes with spotID (returns empty vector on failure) More... | |
| virtual SpectrumPtr | spectrum (const SpectrumPtr &seed, bool getBinaryData) const |
| get a copy of the seed spectrum, optionally with its binary data populated this is useful for formats like mzML that can delay loading of binary data More... | |
| virtual void | warn_once (const char *msg) const |
| issues a warning once per SpectrumList instance (based on string hash) More... | |
| virtual | ~SpectrumList () |
Protected Attributes | |
| CacheType | spectrumCache_ |
| Protected Attributes inherited from pwiz::msdata::SpectrumListWrapper | |
| SpectrumListPtr | inner_ |
| DataProcessingPtr | dp_ |
Private Member Functions | |
| SpectrumListCache (SpectrumListCache &) | |
| SpectrumListCache & | operator= (SpectrumListCache &) |
Detailed Description
adds a level of flexible MRU caching to a SpectrumList processor chain
Definition at line 37 of file SpectrumListCache.hpp.
Member Typedef Documentation
| typedef std::pair<size_t, SpectrumPtr> pwiz::msdata::SpectrumListCache::KeyValuePair |
a cache mapping spectrum indices to SpectrumPtrs
Definition at line 42 of file SpectrumListCache.hpp.
| typedef MemoryMRUCache<KeyValuePair, boost::multi_index::member_offset<KeyValuePair, size_t, first_offset> > pwiz::msdata::SpectrumListCache::CacheType |
Definition at line 44 of file SpectrumListCache.hpp.
Constructor & Destructor Documentation
| pwiz::msdata::SpectrumListCache::SpectrumListCache | ( | const SpectrumListPtr & | inner, |
| MemoryMRUCacheMode | cacheMode, | ||
| size_t | cacheSize | ||
| ) |
|
private |
Member Function Documentation
| pwiz::msdata::SpectrumListCache::BOOST_STATIC_CONSTANT | ( | unsigned | , |
| first_offset | = offsetof(KeyValuePair, first) |
||
| ) |
|
virtual |
returns the requested spectrum which may or may not be cached depending on the current cache mode
Implements pwiz::msdata::SpectrumListWrapper.
Referenced by testFileReads(), testModeBinaryDataOnly(), testModeMetaDataAndBinaryData(), testModeMetaDataOnly(), and testModeOff().
| CacheType& pwiz::msdata::SpectrumListCache::spectrumCache | ( | ) |
returns a reference to the cache, to enable clearing it or changing the mode
Referenced by testModeBinaryDataOnly(), testModeMetaDataAndBinaryData(), testModeMetaDataOnly(), and testModeOff().
| const CacheType& pwiz::msdata::SpectrumListCache::spectrumCache | ( | ) | const |
returns a const-reference to the cache
|
private |
Member Data Documentation
|
mutableprotected |
Definition at line 61 of file SpectrumListCache.hpp.
The documentation for this class was generated from the following file:
- /build/libpwiz-7dHrSc/libpwiz-3.0.6585/pwiz/data/msdata/SpectrumListCache.hpp
