ms_distiller_search_status.hpp

/*
##############################################################################
# file: ms_distiller_search_status.hpp
# 'msparser' toolkit
# An extracted ion chromatogram
##############################################################################
# COPYRIGHT NOTICE
# Copyright 1998-2014 Matrix Science Limited  All Rights Reserved.
#
##############################################################################
 * @(#)$Source: parser/inc/ms_distiller_search_status.hpp $
 * @(#)$Revision: 5f5a3230c85e277f402844ad1dcf49796e9a3e42 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
 * @(#)$Date: 2019-04-03 10:57:19 +0100 $
##############################################################################
 */
 
#ifndef MS_DISTILLER_SEARCH_STATUS_HPP
#define MS_DISTILLER_SEARCH_STATUS_HPP
 
 
// Includes from the standard template library
#include <string>
 
namespace msparser_internal
{
    class ms_XMLHelper;
    class ms_XMLElement;
}
 
namespace matrix_science
{
    //=========================================================================
 
    class MS_MASCOTRESFILE_API ms_distiller_search_status
    {
        public:
            // used internally
            ms_distiller_search_status();
            bool extractXml(msparser_internal::ms_XMLHelper & helper, msparser_internal::ms_XMLElement & element);
 
            int getId() const;
            std::string getTaskId() const;
#ifndef SWIGCSHARP
            std::string getTitle() const;
#else
            std::wstring getTitle() const {
                return getTitleWide();
            };
#endif
            std::string getServer() const;
            std::string getSubmitTime() const; // ISO 8601 date and time format, e.g. "2013-05-29T15:55:40"
            std::string getResultsFile() const;
            std::string getStatusMsg() const; // usually empty
            int getError() const; // zero if no error
 
            std::string getResfileStreamName() const;
            std::string getPeptideSummaryCacheStreamName() const;
 
        private:
            std::wstring getTitleWide() const;
 
            int id_;
            std::string taskId_;
            std::string title_;
            std::string server_;
            std::string submitTime_; // ISO 8601 date and time format, e.g. "2013-05-29T15:55:40"
            std::string resultsFile_;
            std::string statusMsg_;
            int error_;
    };
 // end of quantitation_group
    //=========================================================================
 
} // namespace matrix_science
 
#endif // MS_DISTILLER_SEARCH_STATUS_HPP
 
/*------------------------------- End of File -------------------------------*/