ms_crosslinking_configfile.hpp

/*
##############################################################################
# file: ms_crosslinking_configfile.hpp                                       #
# 'msparser' toolkit                                                         #
# Represents crosslinking.xml file                                           #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2019 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
# $Author: villek@matrixscience.com $ #
# $Date: 2018-12-20 12:05:22 +0000 $ #
# $Revision: 9de60354aaae13272cadfa764dbabd92c93c724c | MSPARSER_REL_2_8_1-0-gea32989045 $ #
##############################################################################
*/

#ifndef MS_CROSSLINKING_CONFIGFILE_HPP
#define MS_CROSSLINKING_CONFIGFILE_HPP


#include <string>
#include <vector>


namespace matrix_science {
    class ms_crosslinking_method; // forward declaration



    class MS_MASCOTRESFILE_API ms_crosslinking_configfile: public ms_errors
    {
    public:
        ms_crosslinking_configfile();

        ms_crosslinking_configfile(const char* fileName, const char* schemaFileName, 
            const ms_connection_settings * cs = 0, bool useSchema = true);

        ms_crosslinking_configfile(const ms_crosslinking_configfile& right);

        virtual ~ms_crosslinking_configfile();

#ifndef SWIG

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

        void copyFrom(const ms_crosslinking_configfile* right);

        virtual void defaultValues();

        std::string getFileName() const;

        void setFileName(const char* filename);

        void setSchemaFileName(const char* name);

        std::string getSchemaFileName() const;

        static std::string getDefaultSchemaFileName();

        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(bool validateAgainstSchema = true);

        std::string validateDocument() const;

        std::string getMajorVersion() const;

        std::string getMinorVersion() const;


        int getNumberOfMethods() const;

        void clearMethods();

        void appendMethod(const ms_crosslinking_method *elem);

        const ms_crosslinking_method * getMethodByNumber(const int idx) const;

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

        bool updateMethodByNumber(const int idx, const ms_crosslinking_method* method);

        bool updateMethodByName(const char *name, const ms_crosslinking_method* method);

        bool deleteMethodByNumber(const int idx);

        bool deleteMethodByName(const char *name);


    private:
        std::string             m_fileName;
        std::string             m_schemaFileName;
        ms_connection_settings  m_cs;

        std::string m_majorVersion;
        std::string m_minorVersion;

        std::string m_encodingName;
        bool m_useSchema;

        typedef std::vector< ms_crosslinking_method* > method_vector;
        method_vector          m_methods;

    }; // class ms_crosslinking_configfile
 // end of config_group

} // namespace matrix_science

#endif // MS_CROSSLINKING_CONFIGFILE_HPP
/*------------------------------- End of File -------------------------------*/