ms_quant_composition.hpp

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

#ifndef MS_QUANT_COMPOSITION_HPP
#define MS_QUANT_COMPOSITION_HPP


#include <string>
#include <vector>

// forward declarations
namespace msparser_internal {
    class ms_quant_xmlloader;
}

namespace matrix_science {

    class ms_xml_schema; // forward declaration


    class MS_MASCOTRESFILE_API ms_quant_element: public ms_xml_IValidatable
    {
        friend class msparser_internal::ms_quant_xmlloader;

    public:
        ms_quant_element();

        ms_quant_element(const ms_quant_element& src);

        virtual ~ms_quant_element();

        void defaultValues();

        void copyFrom(const ms_quant_element* right);

#ifndef SWIG

        ms_quant_element& operator=(const ms_quant_element& 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 haveSymbol() const;

        std::string getSymbol() const;

        void setSymbol(const char* symbol);

        void dropSymbol();

        std::string getSymbolSchemaType() const;

        
        bool haveNumber() const;

        int getNumber() const;

        void setNumber(const int number);

        void dropNumber();

        std::string getNumberSchemaType() const;


    private:
        std::string _symbol;
        bool _symbol_set;

        int _number;
        bool _number_set;

    }; // class ms_quant_element


    class MS_MASCOTRESFILE_API ms_quant_composition: public ms_xml_IValidatable
    {
        friend class msparser_internal::ms_quant_xmlloader;
    public:
        ms_quant_composition();

        ms_quant_composition(const ms_quant_composition& src);

        virtual ~ms_quant_composition();

        void defaultValues();

        void copyFrom(const ms_quant_composition* right);

#ifndef SWIG

        ms_quant_composition& operator=(const ms_quant_composition& 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 getNumberOfElements() const;

        void clearElements();

        void appendElement(const ms_quant_element *element);

        const ms_quant_element * getElement(const int idx) const;

        bool updateElement(const int idx, const ms_quant_element* element);

        bool deleteElement(const int idx);

        std::string getElementSchemaType() const;

    private:
        typedef std::vector< ms_quant_element* > element_vector;
        element_vector _elements;

    }; // class ms_quant_composition
 // end of config_group

} // namespace matrix_science

#endif // MS_QUANT_COMPOSITION_HPP

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