ms_distiller_data.hpp

/*
##############################################################################
# file: ms_distiller_data.hpp
# 'msparser' toolkit
# An extracted ion chromatogram
##############################################################################
# COPYRIGHT NOTICE
# Copyright 1998-2014 Matrix Science Limited  All Rights Reserved.
#
##############################################################################
 * @(#)$Source: parser/inc/ms_distiller_data.hpp $
 * @(#)$Revision: a11a1f9693803472f1a72c5139f8c548fb17b396 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
 * @(#)$Date: 2023-11-21 13:38:16 +0000 $
##############################################################################
 */
 
#ifndef MS_DISTILLER_DATA_HPP
#define MS_DISTILLER_DATA_HPP
 
 
// Includes from the standard template library
#include <string>
#include <vector>
 
namespace msparser_internal
{
    class ms_XMLHelper;
    class ms_XMLElement;
}
 
namespace matrix_science
{
    class ms_distiller_data_quant;
    class ms_distiller_data_search;
 
    //=========================================================================
 
    class MS_MASCOTRESFILE_API ms_distiller_data : 
        public matrix_science::ms_errors
    {
        public:
 
            static time_t getDistillerResfileTimestamp();
 
            static std::vector<std::string> getRequiredSchemaFileNames();
 
            static std::string getDistillerProjectStreamName();            
 
            ms_distiller_data();
            virtual ~ms_distiller_data();
            ms_distiller_data(const ms_distiller_data & copy);
 
            virtual std::string getDistillerVersion() const;
 
            virtual int getDistillerExperimentType() const;
 
            void copyFrom(const ms_distiller_data* right);
 
#ifndef SWIG
            const ms_distiller_data & operator=(const ms_distiller_data & copy);
#endif
 
            virtual int getSearchCount() const;
            virtual const ms_distiller_data_search & getSearch(int index) const;
            virtual int getLoadedSearchIndex() const;
 
            virtual int getQuantCount() const;
            virtual const ms_distiller_data_quant & getQuant(int index) const;
 
            virtual const ms_distiller_data_quant * getQuantForSearch(const std::string & taskId) const;
 
            virtual const ms_datfile & getDatfile() const;
 
            virtual const ms_fragrulesfile & getFragRulesFile() const;
 
            virtual const ms_quant_method & getQuantMethod() const;
 
            virtual ms_mascotresults_params get_ms_mascotresults_params(const int searchIndex) const;
 
            virtual bool loadXml(const char * xmlSchemaPath, const std::string & xmlText);
            virtual bool loadXmlFile(const char * xmlSchemaPath, const std::string & xmlFilename);
            virtual bool loadXmlStream(const char * xmlSchemaPath, matrix_science::ms_input_string_stream * xmlStream);
 
            virtual bool saveXmlFile(const char * xmlSchemaPath, const std::string & xmlFilename);
            virtual int addQuant(const std::string & taskId);
 
        private:
            bool extractXml(const char * xmlSchemaPath, msparser_internal::ms_XMLHelper & helper);
            bool saveXml(const char * xmlSchemaPath, msparser_internal::ms_XMLHelper & helper);
 
            int quantStreamCounter_;
            std::vector<ms_distiller_data_search> searches_;
            std::vector<ms_distiller_data_quant> quantStreams_;
            ms_datfile datfile_;
            ms_fragrulesfile fragfile_;
            ms_quant_method quantMethod_;
            
            msparser_internal::ms_XMLHelper * helper_;
            std::string distillerVersion_;
            std::string serverURL_;
            std::string serverVersion_;
            int distillerExperimentType_ = 0;
    };
 // end of quantitation_group
    //=========================================================================
 
} // namespace matrix_science
 
#endif // MS_DISTILLER_DATA_HPP
 
/*------------------------------- End of File -------------------------------*/