Matrix Science header

ms_distiller_search_status.hpp

00001 /*
00002 ##############################################################################
00003 # file: ms_distiller_search_status.hpp
00004 # 'msparser' toolkit
00005 # An extracted ion chromatogram
00006 ##############################################################################
00007 # COPYRIGHT NOTICE
00008 # Copyright 1998-2014 Matrix Science Limited  All Rights Reserved.
00009 #
00010 ##############################################################################
00011  * @(#)$Source: parser/inc/ms_distiller_search_status.hpp $
00012  * @(#)$Revision: 5f5a3230c85e277f402844ad1dcf49796e9a3e42 | MSPARSER_REL_2_8_1-0-gea32989045 $
00013  * @(#)$Date: 2019-04-03 10:57:19 +0100 $
00014 ##############################################################################
00015  */
00016 
00017 #ifndef MS_DISTILLER_SEARCH_STATUS_HPP
00018 #define MS_DISTILLER_SEARCH_STATUS_HPP
00019 
00020 
00021 // Includes from the standard template library
00022 #include <string>
00023 
00024 namespace msparser_internal
00025 {
00026     class ms_XMLHelper;
00027     class ms_XMLElement;
00028 }
00029 
00030 namespace matrix_science
00031 {
00032     //=========================================================================
00038 
00039 
00042     class MS_MASCOTRESFILE_API ms_distiller_search_status
00043     {
00044         public:
00045             // used internally
00046             ms_distiller_search_status();
00047             bool extractXml(msparser_internal::ms_XMLHelper & helper, msparser_internal::ms_XMLElement & element);
00048 
00050             int getId() const;
00052             std::string getTaskId() const;
00053 #ifndef SWIGCSHARP
00054 
00055             std::string getTitle() const;
00056 #else
00057             std::wstring getTitle() const {
00058                 return getTitleWide();
00059             };
00060 #endif
00061 
00062             std::string getServer() const;
00064             std::string getSubmitTime() const; // ISO 8601 date and time format, e.g. "2013-05-29T15:55:40"
00066             std::string getResultsFile() const;
00068             std::string getStatusMsg() const; // usually empty
00070             int getError() const; // zero if no error
00071 
00073             std::string getResfileStreamName() const;
00075             std::string getPeptideSummaryCacheStreamName() const;
00076 
00077         private:
00078             std::wstring getTitleWide() const;
00079 
00080             int id_;
00081             std::string taskId_;
00082             std::string title_;
00083             std::string server_;
00084             std::string submitTime_; // ISO 8601 date and time format, e.g. "2013-05-29T15:55:40"
00085             std::string resultsFile_;
00086             std::string statusMsg_;
00087             int error_;
00088     };
00089  // end of quantitation_group
00091     //=========================================================================
00092 
00093 } // namespace matrix_science
00094 
00095 #endif // MS_DISTILLER_SEARCH_STATUS_HPP
00096 
00097 /*------------------------------- End of File -------------------------------*/

Copyright © 2022 Matrix Science Ltd.  All Rights Reserved. Generated on Thu Mar 31 2022 01:12:29