ms_quant_component.hpp

/*
##############################################################################
# file: ms_quant_component.hpp                                               #
# 'msparser' toolkit                                                         #
# Encapsulates component-element from "quantitation.xml"-file                #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2006 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_quant_component.hpp $
 * @(#)$Revision: b16aae2ec68e22e8ed391e0142135bc5ee360bea | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
 * @(#)$Date: 2021-10-18 13:38:36 +0100 $
##############################################################################
 */
 
#ifndef MS_QUANT_COMPONENT_HPP
#define MS_QUANT_COMPONENT_HPP
 
 
#include <string>
#include <vector>
 
// forward declarations
namespace msparser_internal {
    class ms_quant_xmlloader;
} 
 
namespace matrix_science {
 
    class ms_quant_modgroup; // forward declaration
    class ms_quant_moverz; // forward declaration
    class ms_quant_correction; // forward declaration
    class ms_quant_isotope; // forward declaration
    class ms_quant_satellite; // forward declaration
    class ms_xml_schema; // forward declaration
 
 
    class MS_MASCOTRESFILE_API ms_quant_component: public ms_xml_IValidatable
    {
        friend class msparser_internal::ms_quant_xmlloader;
 
    public:
        ms_quant_component();
 
        ms_quant_component(const ms_quant_component& src);
 
        virtual ~ms_quant_component();
 
        void defaultValues();
 
        void copyFrom(const ms_quant_component* right);
 
#ifndef SWIG
        ms_quant_component& operator=(const ms_quant_component& 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;
 
 
        bool haveMoverz() const;
 
        const ms_quant_moverz* getMoverz() const;
 
        void setMoverz(const ms_quant_moverz* moverz);
 
        void dropMoverz();
 
        std::string getMoverzSchemaType() const;
 
 
        int getNumberOfModificationGroups() const;
 
        void clearModificationGroups();
 
        void appendModificationGroup(const ms_quant_modgroup *item);
 
        const ms_quant_modgroup * getModificationGroupByNumber(const int idx) const;
 
        const ms_quant_modgroup * getModificationGroupByName(const char *name) const;
 
        bool updateModificationGroupByNumber(const int idx, const ms_quant_modgroup* modgroup);
 
        bool updateModificationGroupByName(const char *name, const ms_quant_modgroup* modgroup);
 
        bool deleteModificationGroupByNumber(const int idx);
 
        bool deleteModificationGroupByName(const char *name);
 
        std::string getModificationGroupSchemaType() const;
 
 
        int getNumberOfIsotopes() const;
 
        void clearIsotopes();
 
        void appendIsotope(const ms_quant_isotope* isotope);
 
        const ms_quant_isotope* getIsotope(const int idx) const;
 
        bool updateIsotope(const int idx, const ms_quant_isotope* isotope);
 
        bool deleteIsotope(const int idx);
 
        std::string getIsotopeSchemaType() const;
 
 
 
        bool haveFileIndex() const;
 
        int getFileIndex() const;
 
        void setFileIndex(const int file_index);
 
        void dropFileIndex();
 
        std::string getFileIndexSchemaType() const;
 
        int getNumberOfFileIndexes() const;
 
        void clearFileIndexes();
 
        void appendFileIndex(const ms_quant_file_index * file_index);
 
        const ms_quant_file_index* getFileIndex(const int idx) const;
 
        bool updateFileIndex(const int idx, const ms_quant_file_index * file_index);
 
        bool deleteFileIndex(const int idx);
 
 
        int getNumberOfCorrections() const;
 
        void clearCorrections();
 
        void appendCorrection(const ms_quant_correction* correction);
 
        const ms_quant_correction* getCorrection(const int idx) const;
 
        bool updateCorrection(const int idx, const ms_quant_correction* isotope);
 
        bool deleteCorrection(const int idx);
 
        std::string getCorrectionSchemaType() const;
 
 
        bool haveName() const;
 
        std::string getName() const;
 
        void setName(const char* value);
 
        void dropName();
 
        std::string getNameSchemaType() const;
 
 
        bool haveSatellite() const;
 
        const ms_quant_satellite* getSatellite() const;
 
        void setSatellite(const ms_quant_satellite* satellite);
 
        void dropSatellite();
 
        std::string getSatelliteSchemaType() const;
 
    private:
        // elements
        ms_quant_moverz *_pMoverz;
        bool _moverz_set;
 
        typedef std::vector< ms_quant_modgroup* > modgroup_vector;
        modgroup_vector _modgroups;
 
        typedef std::vector< ms_quant_isotope* > isotope_vector;
        isotope_vector _isotopes;
 
        typedef std::vector< ms_quant_file_index *> file_index_vector;
        file_index_vector _file_indexes;
 
        typedef std::vector< ms_quant_correction* > correction_vector;
        correction_vector _corrections;
 
        // attributes
        std::string _name;
        bool _name_set;
 
        ms_quant_satellite *_pSatellite;
        bool _satellite_set;
    }; // class ms_quant_component
 // end of config_group
 
} // namespace matrix_science
 
#endif // MS_QUANT_COMPONENT_HPP
 
/*------------------------------- End of File -------------------------------*/