ms_quant_ratio.hpp

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

#ifndef MS_QUANT_RATIO_HPP
#define MS_QUANT_RATIO_HPP


#include <string>
#include <vector>

// forward declarations
namespace msparser_internal {
    class ms_quant_xmlloader;
}

namespace matrix_science {

    class ms_quant_numerator; // forward declaration
    class ms_xml_schema; // forward declaration


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

    public:
        ms_quant_ratio();

        ms_quant_ratio(const ms_quant_ratio& src);

        virtual ~ms_quant_ratio();

        void defaultValues();

        void copyFrom(const ms_quant_ratio* right);

#ifndef SWIG

        ms_quant_ratio& operator=(const ms_quant_ratio& 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 getNumberOfNumerators() const;

        void clearNumerators();

        void appendNumerator(const ms_quant_numerator *numerator);

        const ms_quant_numerator * getNumeratorByNumber(const int idx) const;

        const ms_quant_numerator * getNumeratorByName(const char *name) const;

        bool updateNumeratorByNumber(const int idx, const ms_quant_numerator* numerator);

        bool updateNumeratorByName(const char *name, const ms_quant_numerator* numerator);

        bool deleteNumeratorByNumber(const int idx);

        bool deleteNumeratorByName(const char *name);

        std::string getNumeratorSchemaType() const;


        int getNumberOfDenominators() const;

        void clearDenominators();

        void appendDenominator(const ms_quant_numerator *denominator);

        const ms_quant_numerator * getDenominatorByNumber(const int idx) const;

        const ms_quant_numerator * getDenominatorByName(const char *name) const;

        bool updateDenominatorByNumber(const int idx, const ms_quant_numerator* denominator);

        bool updateDenominatorByName(const char *name, const ms_quant_numerator* denominator);

        bool deleteDenominatorByNumber(const int idx);

        bool deleteDenominatorByName(const char *name);

        std::string getDenominatorSchemaType() const;


        bool haveName() const;

        std::string getName() const;

        void setName(const char* value);

        void dropName();

        std::string getNameSchemaType() const;

    private:
        typedef std::vector< ms_quant_numerator* > numerator_vector;
        numerator_vector _numerators;

        numerator_vector _denominators;

        std::string _name;
        bool _name_set;

    }; // class ms_quant_ratio
 // end of config_group

} // namespace matrix_science

#endif // MS_QUANT_RATIO_HPP

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