ms_quant_modgroup.hpp

/*
##############################################################################
# file: ms_quant_modgroup.hpp                                                #
# 'msparser' toolkit                                                         #
# Encapsulates modification_group-element from "quantitation.xml"-file       #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2006 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_quant_modgroup.hpp $
 * @(#)$Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
 * @(#)$Date: 2018-07-30 16:23:53 +0100 $
##############################################################################
 */
 
#ifndef MS_QUANT_MODGROUP_HPP
#define MS_QUANT_MODGROUP_HPP
 
 
#include <string>
#include <vector>
 
// forward declarations
namespace msparser_internal {
    class ms_quant_xmlloader;
}
 
namespace matrix_science {
 
    class ms_quant_unmodified; // forward declaration
    class ms_quant_localdef; // forward declaration
    class ms_xml_schema; // forward declaration
 
 
    class MS_MASCOTRESFILE_API ms_quant_modgroup: public ms_xml_IValidatable
    {
        friend class msparser_internal::ms_quant_xmlloader;
 
    public:
        ms_quant_modgroup();
 
        ms_quant_modgroup(const ms_quant_modgroup& src);
 
        virtual ~ms_quant_modgroup();
 
        void defaultValues();
 
        void copyFrom(const ms_quant_modgroup* right);
 
#ifndef SWIG
        ms_quant_modgroup& operator=(const ms_quant_modgroup& right);
#endif
        virtual std::string getSchemaType() const;
 
        virtual std::string validateShallow(const ms_xml_schema *pSchemaFileObj) const;
 
        virtual std::string validateDeep(const ms_xml_schema *pSchemaFileObj) const;
 
 
        int getNumberOfModFiles() const;
 
        void clearModFiles();
 
        void appendModFile(const char* mod);
 
        int findModFile(const char* mod) const;
 
        std::string getModFile(const int idx) const;
 
        bool deleteModFile(const int idx);
 
        std::string getModFileSchemaType() const;
 
 
        int getNumberOfUnmodified() const;
 
        void clearUnmodified();
 
        void appendUnmodified(const ms_quant_unmodified* unmodified);
 
        const ms_quant_unmodified* getUnmodified(const int idx) const;
 
        bool updateUnmodified(const int idx, const ms_quant_unmodified* unmodified);
 
        bool deleteUnmodified(const int idx);
 
        std::string getUnmodifiedSchemaType() const;
 
 
        int getNumberOfLocalDefinitions() const;
 
        void clearLocalDefinitions();
 
        void appendLocalDefinition(const ms_quant_localdef* localdef);
 
        const ms_quant_localdef* getLocalDefinition(const int idx) const;
 
        bool updateLocalDefinition(const int idx, const ms_quant_localdef* localdef);
 
        bool deleteLocalDefinition(const int idx);
 
        std::string getLocalDefinitionSchemaType() const;
 
 
        bool haveName() const;
 
        std::string getName() const;
 
        void setName(const char* value);
 
        void dropName();
 
        std::string getNameSchemaType() const;
 
 
        bool haveMode() const;
 
        std::string getMode() const;
 
        void setMode(const char* value);
 
        void dropMode();
 
        std::string getModeSchemaType() const;
 
 
        bool haveRequired() const;
 
        bool isRequired() const;
 
        void setRequired(bool value);
 
        void dropRequired();
 
        std::string getRequiredSchemaType() const;
 
    private:
 
        typedef std::vector< std::string > modfile_vector;
        modfile_vector _modFiles;
 
        typedef std::vector< ms_quant_unmodified* > unmodified_vector;
        unmodified_vector _unmodified;
 
        typedef std::vector< ms_quant_localdef* > localdef_vector;
        localdef_vector _localdefs;
 
        std::string _name;
        bool _name_set;
 
        std::string _mode;
        bool _mode_set;
 
        bool m_required;
        bool m_required_set;
 
    }; // class ms_quant_modgroup
 // end of config_group
 
} // namespace matrix_science
 
#endif // MS_QUANT_MODGROUP_HPP
 
/*------------------------------- End of File -------------------------------*/