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

A list of Mascot search status values, typically stored in a Distiller project file. More...

#include <ms_distiller_search_status_list.hpp>

Inheritance diagram for ms_distiller_search_status_list:
Collaboration diagram for ms_distiller_search_status_list:

Public Member Functions

 ms_distiller_search_status_list (const ms_distiller_search_status_list &src)
 
void appendErrors (const ms_errors &src)
 Copies all errors from another instance and appends them at the end of own list.
 
void clearAllErrors ()
 Remove all errors from the current list of errors.
 
void copyFrom (const ms_distiller_search_status_list *right)
 
void copyFrom (const ms_errors *right)
 Use this member to make a copy of another instance.
 
const ms_errsgetErrorHandler () const
 Retrive the error object using this function to get access to all errors and error parameters.
 
int getLastError () const
 Return the error description of the last error that occurred.
 
std::string getLastErrorString () const
 Return the error description of the last error that occurred.
 
int getNumSearches () const
 Return the number of searches in the search status list.
 
const ms_distiller_search_statusgetSearch (int index) const
 Return the selected search status from the search status list.
 
bool isValid () const
 Call this function to determine if there have been any errors.
 
bool loadXml (const char *xmlSchemaPath, const std::string &xmlText)
 Load the search status list from the supplied XML text.
 
bool loadXmlFile (const char *xmlSchemaPath, const std::string &xmlFilename)
 Load the search status list from the XML in the named file.
 
bool loadXmlStream (const char *xmlSchemaPath, matrix_science::ms_input_string_stream *xmlStream)
 Load the search status list from a stream.
 
ms_distiller_search_status_listoperator= (const ms_distiller_search_status_list &right)
 

Static Public Member Functions

static std::string getSearchStatusListStreamName ()
 Return the name of the stream, within the subproject file, used for the search list.
 

Detailed Description

A list of Mascot search status values, typically stored in a Distiller project file.

This is stored in XML in the 'mdro_search_status' stream.

Constructor & Destructor Documentation

◆ ms_distiller_search_status_list()

Parameters
srcis the source to initialise from

Member Function Documentation

◆ appendErrors()

void appendErrors ( const ms_errors src)
inherited

Copies all errors from another instance and appends them at the end of own list.

Parameters
srcThe object to copy the errors across from. See Maintaining object references: two rules of thumb.

◆ clearAllErrors()

void clearAllErrors ( )
inherited

Remove all errors from the current list of errors.

The list of 'errors' can include fatal errors, warning messages, information messages and different levels of debugging messages.

All messages are accumulated into a list in this object, until clearAllErrors() is called.

See Error Handling.

See also
isValid(), getLastError(), getLastErrorString(), getErrorHandler()
Examples
common_error.cpp, resfile_error.cpp, and resfile_summary.cpp.

◆ copyFrom() [1/2]

void copyFrom ( const ms_distiller_search_status_list right)
Parameters
rightis the source to initialise from

◆ copyFrom() [2/2]

void copyFrom ( const ms_errors right)
inherited

Use this member to make a copy of another instance.

Parameters
rightis the source to initialise from

◆ getErrorHandler()

const ms_errs * getErrorHandler ( ) const
inherited

Retrive the error object using this function to get access to all errors and error parameters.

See Error Handling.

Returns
Constant pointer to the error handler
See also
isValid(), getLastError(), getLastErrorString(), clearAllErrors(), getErrorHandler()
Examples
common_error.cpp, and http_helper_getstring.cpp.

◆ getLastError()

int getLastError ( ) const
inherited

Return the error description of the last error that occurred.

All errors are accumulated into a list in this object, until clearAllErrors() is called. This function returns the last error that occurred.

See Error Handling.

See also
isValid(), getLastErrorString(), clearAllErrors(), getErrorHandler()
Returns
the error number of the last error, or 0 if there have been no errors.

◆ getLastErrorString()

std::string getLastErrorString ( ) const
inherited

Return the error description of the last error that occurred.

All errors are accumulated into a list in this object, until clearAllErrors() is called. This function returns the last error that occurred.

Returns
Most recent error, warning, information or debug message

See Error Handling.

See also
isValid(), getLastError(), clearAllErrors(), getErrorHandler()
Examples
common_error.cpp, config_enzymes.cpp, config_fragrules.cpp, config_license.cpp, config_mascotdat.cpp, config_masses.cpp, config_modfile.cpp, config_procs.cpp, config_quantitation.cpp, config_taxonomy.cpp, http_helper_getstring.cpp, and tools_aahelper.cpp.

◆ getNumSearches()

int getNumSearches ( ) const

Return the number of searches in the search status list.

Returns
The number of search statuses in the list.

◆ getSearch()

const matrix_science::ms_distiller_search_status & getSearch ( int  index) const

Return the selected search status from the search status list.

Parameters
indexThe search status's index (1..getNumSearches()).
Returns
The selected search status.

◆ getSearchStatusListStreamName()

std::string getSearchStatusListStreamName ( )
static

Return the name of the stream, within the subproject file, used for the search list.

Returns
The name of the stream containing the results list data.

◆ isValid()

bool isValid ( ) const
inherited

◆ loadXml()

bool loadXml ( const char *  xmlSchemaPath,
const std::string &  xmlText 
)

Load the search status list from the supplied XML text.

Parameters
xmlSchemaPathThe path to the location of the XML schema (XSD) files.
xmlTextThe XML data to load.
Returns
True if the XML file was parsed and loaded successfully.

◆ loadXmlFile()

bool loadXmlFile ( const char *  xmlSchemaPath,
const std::string &  xmlFilename 
)

Load the search status list from the XML in the named file.

If the schema path contains spaces, it should be prefixed with "file:///" and the spaces should be replaced with "%20"

Parameters
xmlSchemaPathThe path to the location of the XML schema (XSD) files.
xmlFilenameThe path and filename of the XML file to load.
Returns
True if the XML file was parsed and loaded successfully.

◆ loadXmlStream()

bool loadXmlStream ( const char *  xmlSchemaPath,
matrix_science::ms_input_string_stream *  xmlStream 
)

Load the search status list from a stream.

Parameters
xmlSchemaPathThe path to the location of the XML schema (XSD) files.
xmlStreamThe stream interface offering the data.
Returns
True if the data was parsed and loaded successfully.

◆ operator=()

Parameters
rightis the source to initialise from
Returns
reference to the current object

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