ms_distiller_search_status Class Reference

A Mascot search status from a Distiller project file. More...

#include <ms_distiller_search_status.hpp>

Public Member Functions
int	getError () const
	Return the error message code, if any, received from the Mascot search.
int	getId () const
	Return the id number used in the names of the results file stream and peptide summary cache stream.
std::string	getPeptideSummaryCacheStreamName () const
	Return the name of the peptide summary cache stream.
std::string	getResfileStreamName () const
	Return the name of the results file stream.
std::string	getResultsFile () const
	Return the name on the Mascot server of the file containing the results.
std::string	getServer () const
	Return the URL of the Mascot server.
std::string	getStatusMsg () const
	Return the status message, if any, received from the Mascot search.
std::string	getSubmitTime () const
	Return the time the search was submitted to the Mascot server.
std::string	getTaskId () const
	Return the Mascot search task ID.
std::string	getTitle () const
	Return the Mascot search title.

Detailed Description

A Mascot search status from a Distiller project file.

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

Member Function Documentation

getError()

int getError

(

)

const

Return the error message code, if any, received from the Mascot search.

Returns

The error code, if any, received from mascot server.

getId()

int getId

(

)

const

Return the id number used in the names of the results file stream and peptide summary cache stream.

Returns

The identifier for the search identifier within the Distiller project.

getPeptideSummaryCacheStreamName()

std::string getPeptideSummaryCacheStreamName

(

)

const

Return the name of the peptide summary cache stream.

Returns

The name of the stream containing the peptide summary data.

getResfileStreamName()

std::string getResfileStreamName

(

)

const

Return the name of the results file stream.

Returns

The name of the stream containing the results file data.

getResultsFile()

std::string getResultsFile

(

)

const

Return the name on the Mascot server of the file containing the results.

Returns

The name of the results file on the Mascot server.

getServer()

std::string getServer

(

)

const

Return the URL of the Mascot server.

Returns

The URL of the Mascot server.

getStatusMsg()

std::string getStatusMsg

(

)

const

Return the status message, if any, received from the Mascot search.

Returns

The text of the status message, if any, received from mascot server.

getSubmitTime()

std::string getSubmitTime

(

)

const

Return the time the search was submitted to the Mascot server.

Returns

The time the search was submitted to the Mascot server.

getTaskId()

std::string getTaskId

(

)

const

Return the Mascot search task ID.

Returns

The Mascot task identifier.

getTitle()

std::string getTitle

(

)

const

Return the Mascot search title.

Returns

The title of the Mascot search.

---

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

• ms_distiller_search_status.hpp
• ms_distiller_search_status.cpp