Class which handles the communication between OpenMS and the Mascot server. More...
#include <OpenMS/FORMAT/MascotRemoteQuery.h>
Public Slots | |
void | run () |
Signals | |
void | done () |
void | gotRedirect (const QHttpResponseHeader &resp) |
Public Member Functions | |
void | setQuerySpectra (const String &exp) |
sets the query spectra, given in MGF file format More... | |
const QByteArray & | getMascotXMLResponse () const |
returns the Mascot XML response which contains the identifications More... | |
bool | hasError () const |
predicate which returns true if an error occurred during the query More... | |
const String & | getErrorMessage () const |
returns the error message, if hasError can be used to check whether an error has occurred More... | |
Constructors and destructors | |
MascotRemoteQuery (QObject *parent=0) | |
default constructor More... | |
virtual | ~MascotRemoteQuery () |
destructor More... | |
![]() | |
DefaultParamHandler (const String &name) | |
Constructor with name that is displayed in error messages. More... | |
DefaultParamHandler (const DefaultParamHandler &rhs) | |
Copy constructor. More... | |
virtual | ~DefaultParamHandler () |
Destructor. More... | |
virtual DefaultParamHandler & | operator= (const DefaultParamHandler &rhs) |
Assignment operator. More... | |
virtual bool | operator== (const DefaultParamHandler &rhs) const |
Equality operator. More... | |
void | setParameters (const Param ¶m) |
Sets the parameters. More... | |
const Param & | getParameters () const |
Non-mutable access to the parameters. More... | |
const Param & | getDefaults () const |
Non-mutable access to the default parameters. More... | |
const String & | getName () const |
Non-mutable access to the name. More... | |
void | setName (const String &name) |
Mutable access to the name. More... | |
const std::vector< String > & | getSubsections () const |
Non-mutable access to the registered subsections. More... | |
Protected Member Functions | |
virtual void | updateMembers_ () |
This method is used to update extra member variables at the end of the setParameters() method. More... | |
![]() | |
void | defaultsToParam_ () |
Updates the parameters after the defaults have been set in the constructor. More... | |
Private Slots | |
void | timedOut () |
void | readyReadSlot (const QHttpResponseHeader &resp) |
void | httpRequestFinished (int request_id, bool error) |
void | httpDataReadProgress (int bytes_read, int bytes_total) |
slot connected to signal dataReadProgress of QHttp More... | |
void | httpDataSendProgress (int bytes_sent, int bytes_total) |
slot connected to signal dataSendProgress of QHttp More... | |
void | httpRequestStarted (int request_id) |
slot connected to signal requestStarted of QHttp, which indicates that the processing of request request_id has been started More... | |
void | httpStateChanged (int state) |
void | httpDone (bool error) |
slot connected to signal done of QHttp More... | |
void | readResponseHeader (const QHttpResponseHeader &response_header) |
slot connect to responseHeaderRecieved, which indicates that a new response header is available More... | |
void | login () |
void | execQuery () |
void | getResults (QString results_path) |
void | followRedirect (const QHttpResponseHeader &resp) |
Private Member Functions | |
MascotRemoteQuery & | operator= (const MascotRemoteQuery &rhs) |
assignment operator More... | |
MascotRemoteQuery (const MascotRemoteQuery &rhs) | |
copy constructor More... | |
void | endRun_ () |
void | logHeader_ (const QHttpHeader &header, const String &what) |
Write HTTP header to error stream (for debugging) More... | |
void | removeHostName_ (QString &url) |
Remove host name information from an url, e.g., "http://www.google.de/search" -> "search". More... | |
Private Attributes | |
String | query_spectra_ |
QByteArray | mascot_xml_ |
QHttp * | http_ |
QString | cookie_ |
String | error_message_ |
QTimer | timeout_ |
Int | to_ |
String | server_path_ |
Path on mascot server. More... | |
String | host_name_ |
Hostname of the mascot server. More... | |
bool | requires_login_ |
Login required. More... | |
bool | use_ssl_ |
Use SSL connection. More... | |
String | boundary_ |
boundary string that will be embedded into the HTTP requests More... | |
Additional Inherited Members | |
![]() | |
Param | param_ |
Container for current parameters. More... | |
Param | defaults_ |
Container for default parameters. This member should be filled in the constructor of derived classes! More... | |
std::vector< String > | subsections_ |
Container for registered subsections. This member should be filled in the constructor of derived classes! More... | |
String | error_name_ |
Name that is displayed in error messages during the parameter checking. More... | |
bool | check_defaults_ |
If this member is set to false no checking if parameters in done;. More... | |
bool | warn_empty_defaults_ |
If this member is set to false no warning is emitted when defaults are empty;. More... | |
Class which handles the communication between OpenMS and the Mascot server.
This class provides a communication interface which is able to query the Mascot server and reports the identifications provided be the Mascot server
MascotRemoteQuery | ( | QObject * | parent = 0 | ) |
default constructor
|
virtual |
destructor
|
private |
copy constructor
|
signal |
|
private |
|
privateslot |
|
privateslot |
const String& getErrorMessage | ( | ) | const |
returns the error message, if hasError can be used to check whether an error has occurred
const QByteArray& getMascotXMLResponse | ( | ) | const |
returns the Mascot XML response which contains the identifications
|
privateslot |
|
signal |
bool hasError | ( | ) | const |
predicate which returns true if an error occurred during the query
|
privateslot |
slot connected to signal dataReadProgress of QHttp
|
privateslot |
slot connected to signal dataSendProgress of QHttp
|
privateslot |
slot connected to signal done of QHttp
|
privateslot |
slot connected to signal requestFinished of QHttp: "This signal is emitted when processing the request identified by id has finished. error is true if an error occurred during the processing; otherwise error is false"
|
privateslot |
slot connected to signal requestStarted of QHttp, which indicates that the processing of request request_id has been started
|
privateslot |
slot connected to signal stateChanged of QHttp, which is emitted if the http state changed. See 'enum QHttp::State' of Qt docu for more info.
|
private |
Write HTTP header to error stream (for debugging)
|
privateslot |
|
private |
assignment operator
|
privateslot |
slot connect to responseHeaderRecieved, which indicates that a new response header is available
|
privateslot |
|
private |
Remove host name information from an url, e.g., "http://www.google.de/search" -> "search".
The | url that will be manipulated. |
|
slot |
void setQuerySpectra | ( | const String & | exp | ) |
sets the query spectra, given in MGF file format
|
privateslot |
|
protectedvirtual |
This method is used to update extra member variables at the end of the setParameters() method.
Also call it at the end of the derived classes' copy constructor and assignment operator.
The default implementation is empty.
Reimplemented from DefaultParamHandler.
|
private |
boundary string that will be embedded into the HTTP requests
|
private |
|
private |
|
private |
Hostname of the mascot server.
|
private |
|
private |
|
private |
|
private |
Login required.
|
private |
Path on mascot server.
|
private |
|
private |
|
private |
Use SSL connection.
OpenMS / TOPP release 2.0.0 | Documentation generated on Wed Mar 30 2016 12:49:28 using doxygen 1.8.11 |