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: /vol/cvsroot/parser/inc/ms_distiller_search_status.hpp,v $
00012  * @(#)$Revision: 1.2 $
00013  * @(#)$Date: 2014/02/07 17:07:04 $
00014 ##############################################################################
00015  */
00016 
00017 #ifndef MS_DISTILLER_SEARCH_STATUS_HPP
00018 #define MS_DISTILLER_SEARCH_STATUS_HPP
00019 
00020 #ifdef _WIN32
00021 #pragma warning(disable:4251)   // Don't want all classes to be exported
00022 #pragma warning(disable:4786)   // Debug symbols too long
00023 #   ifndef _MATRIX_USE_STATIC_LIB
00024 #       ifdef MS_MASCOTRESFILE_EXPORTS
00025 #           define MS_MASCOTRESFILE_API __declspec(dllexport)
00026 #       else
00027 #           define MS_MASCOTRESFILE_API __declspec(dllimport)
00028 #       endif
00029 #   else
00030 #       define MS_MASCOTRESFILE_API
00031 #   endif
00032 #else
00033 #   define MS_MASCOTRESFILE_API
00034 #endif
00035 
00036 // Includes from the standard template library
00037 #include <string>
00038 
00039 
00040 namespace msparser_internal
00041 {
00042     class ms_XMLHelper;
00043     class ms_XMLElement;
00044 }
00045 
00046 namespace matrix_science
00047 {
00048     //=========================================================================
00054 
00055 
00058     class MS_MASCOTRESFILE_API ms_distiller_search_status
00059     {
00060         public:
00061             // used internally
00062             ms_distiller_search_status();
00063             bool extractXml(msparser_internal::ms_XMLHelper & helper, msparser_internal::ms_XMLElement & element);
00064 
00066             int getId() const;
00068             std::string getTaskId() const;
00070             std::string getTitle() const;
00072             std::string getServer() const;
00074             std::string getSubmitTime() const; // ISO 8601 date and time format, e.g. "2013-05-29T15:55:40"
00076             std::string getResultsFile() const;
00078             std::string getStatusMsg() const; // usually empty
00080             int getError() const; // zero if no error
00081 
00083             std::string getResfileStreamName() const;
00085             std::string getPeptideSummaryCacheStreamName() const;
00086 
00087         private:
00088             int id_;
00089             std::string taskId_;
00090             std::string title_;
00091             std::string server_;
00092             std::string submitTime_; // ISO 8601 date and time format, e.g. "2013-05-29T15:55:40"
00093             std::string resultsFile_;
00094             std::string statusMsg_;
00095             int error_;
00096     };
00097  // end of quantitation_group
00099     //=========================================================================
00100 
00101 } // namespace matrix_science
00102 
00103 #endif // MS_DISTILLER_SEARCH_STATUS_HPP
00104 
00105 /*------------------------------- End of File -------------------------------*/
Copyright © 2016 Matrix Science Ltd.  All Rights Reserved. Generated on Fri Jun 2 2017 01:44:50