A list of Mascot search status values, typically stored in a Distiller project file. More...
#include <ms_distiller_search_status_list.hpp>
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_errs * | getErrorHandler () 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_status & | getSearch (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_list & | operator= (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. | |
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.
ms_distiller_search_status_list | ( | const ms_distiller_search_status_list & | src | ) |
src | is the source to initialise from |
|
inherited |
Copies all errors from another instance and appends them at the end of own list.
src | The object to copy the errors across from. See Maintaining object references: two rules of thumb. |
|
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.
void copyFrom | ( | const ms_distiller_search_status_list * | right | ) |
right | is the source to initialise from |
|
inherited |
Use this member to make a copy of another instance.
right | is the source to initialise from |
|
inherited |
Retrive the error object using this function to get access to all errors and error parameters.
See Error Handling.
|
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.
|
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.
int getNumSearches | ( | ) | const |
Return the number of searches in the search status list.
const matrix_science::ms_distiller_search_status & getSearch | ( | int | index | ) | const |
Return the selected search status from the search status list.
index | The search status's index (1..getNumSearches()). |
|
static |
Return the name of the stream, within the subproject file, used for the search list.
|
inherited |
Call this function to determine if there have been any errors.
This will return true unless there have been any fatal errors.
See Error Handling.
bool loadXml | ( | const char * | xmlSchemaPath, |
const std::string & | xmlText | ||
) |
Load the search status list from the supplied XML text.
xmlSchemaPath | The path to the location of the XML schema (XSD) files. |
xmlText | The XML data to load. |
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"
xmlSchemaPath | The path to the location of the XML schema (XSD) files. |
xmlFilename | The path and filename of the XML file to load. |
bool loadXmlStream | ( | const char * | xmlSchemaPath, |
matrix_science::ms_input_string_stream * | xmlStream | ||
) |
Load the search status list from a stream.
xmlSchemaPath | The path to the location of the XML schema (XSD) files. |
xmlStream | The stream interface offering the data. |
ms_distiller_search_status_list & operator= | ( | const ms_distiller_search_status_list & | right | ) |
right | is the source to initialise from |