Matrix Science Mascot Parser toolkit
 
Loading...
Searching...
No Matches
ms_distiller_master_search Class Reference

The details of a Distiller multifile search. More...

#include <ms_distiller_master_search.hpp>

Public Member Functions

virtual std::string getCacheFilename () const
 Return the name of the cache file Distiller used.
 
virtual std::string getCombinedPeptideSummaryCacheStreamName () const
 Return the path and name of the peptide summary cache stream.
 
virtual int getId () const
 Return the identifier for the peptide summary cache stream in the master project file.
 
virtual int getNumSubsearches () const
 Return the number of subsearches in the master search.
 
virtual const ms_distiller_subsearchgetSubsearch (int index) const
 Return the selected search (index 1..n).
 

Detailed Description

The details of a Distiller multifile search.

A list of these is stored in XML in the Distiller master project file.

Member Function Documentation

◆ getCacheFilename()

std::string getCacheFilename ( ) const
virtual

Return the name of the cache file Distiller used.

Returns
The path and name of the file Distiller used to contain the peptide summary cache data.

◆ getCombinedPeptideSummaryCacheStreamName()

std::string getCombinedPeptideSummaryCacheStreamName ( ) const
virtual

Return the path and name of the peptide summary cache stream.

Returns
The name of the stream containing the peptide summary cache data.

◆ getId()

int getId ( ) const
virtual

Return the identifier for the peptide summary cache stream in the master project file.

Returns
The identifier for the peptide summary cache stream in the master project file.

◆ getNumSubsearches()

int getNumSubsearches ( ) const
virtual

Return the number of subsearches in the master search.

Returns
The number of subsearches in the master search.

◆ getSubsearch()

const matrix_science::ms_distiller_subsearch & getSubsearch ( int  index) const
virtual

Return the selected search (index 1..n).

Parameters
indexThe subsearch's index (1..getNumSubsearches()).
Returns
The selected subsearch.

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