ms_quant_configfile.hpp

/*
##############################################################################
# file: ms_quant_configfile.hpp                                              #
# 'msparser' toolkit                                                         #
# Encapsulates "quantitation.xml"-file that serves as quantitation       #
# configuration file                                                         #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2006 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_quant_configfile.hpp $
 * @(#)$Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_2_8_1-0-gea32989045 $
 * @(#)$Date: 2018-07-30 16:23:53 +0100 $
##############################################################################
 */

#ifndef MS_QUANT_CONFIGFILE_HPP
#define MS_QUANT_CONFIGFILE_HPP


#include <string>

// forward declarations
namespace msparser_internal {
    class ms_quant_xmlloader;
    class ms_quant_configfile_impl;
} 

namespace matrix_science {

    class ms_connection_settings; // forward declaration
    class ms_quant_method; // forward declaration



    class MS_MASCOTRESFILE_API ms_quant_configfile: public ms_errors
    {
        friend class msparser_internal::ms_quant_xmlloader;
    public:
        ms_quant_configfile();

        ms_quant_configfile(const ms_quant_configfile& src);

        ms_quant_configfile(const char* fileName, const char* schemaFileName,
                   const ms_connection_settings * cs = 0);

        ~ms_quant_configfile();

        void defaultValues();

        void copyFrom(const ms_quant_configfile* right);

#ifndef SWIG

        ms_quant_configfile& operator=(const ms_quant_configfile& right);
#endif

        void setFileName(const char* name);

        std::string getFileName() const;

        void setSchemaFileName(const char* name);

        std::string getSchemaFileName() const;

        void setSchemaDirectory(const char * dir);

        std::string getSchemaDirectory() const;

        void setConnectionSettings(const ms_connection_settings & cs);

        ms_connection_settings getConnectionSettings() const;

        void read_file();

        void save_file();

        void read_buffer(const char *buffer);

        std::string save_buffer();

        std::string validateDocument() const;

        int getNumberOfMethods() const;

        void clearMethods();

        void appendMethod(const ms_quant_method *item);

        const ms_quant_method * getMethodByNumber(const int idx) const;

        const ms_quant_method * getMethodByName(const char *name) const;

        bool updateMethodByNumber(const int idx, const ms_quant_method *mod);

        bool updateMethodByName(const char *name, const ms_quant_method *mod);

        bool deleteMethodByNumber(const int idx);

        bool deleteMethodByName(const char *name);

        std::string getMajorVersion() const;

        std::string getMinorVersion() const;

    private:
        msparser_internal::ms_quant_configfile_impl * m_pImpl;
    }; // class ms_quant_configfile
 // end of config_group

} // namespace matrix_science

#endif // MS_QUANT_CONFIGFILE_HPP

/*------------------------------- End of File -------------------------------*/