ms_quant_parameters.hpp

/*
##############################################################################
# file: ms_quant_parameters.hpp                                              #
# 'msparser' toolkit                                                         #
# Encapsulates parametersType-definition from "quantitation.xml"-file        #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2006 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_quant_parameters.hpp $
 * @(#)$Revision: 8fee77726a13a239ca8bcf2b46212bff297db9b7 | MSPARSER_REL_2_8_1-0-gea32989045 $
 * @(#)$Date: 2018-12-20 10:50:55 +0000 $
##############################################################################
 */

#ifndef MS_QUANT_PARAMETERS_HPP
#define MS_QUANT_PARAMETERS_HPP


#include <string>
#include <vector>

namespace msparser_internal {
    class ms_quant_xmlloader;
}

namespace matrix_science {
    class ms_xml_schema; // forward declaration
    class ms_xml_parameter;
    class ms_xml_parameters;


    class MS_MASCOTRESFILE_API ms_quant_parameter: public ms_xml_parameter
    {
        friend class msparser_internal::ms_quant_xmlloader;

    public:
        ms_quant_parameter();

        ms_quant_parameter(const ms_quant_parameter& src);

        virtual ~ms_quant_parameter();

        void copyFrom(const ms_quant_parameter* right);

#ifndef SWIG

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

        virtual std::string getSchemaType() const;

        virtual std::string getNameSchemaType() const;

        virtual std::string getDescriptionSchemaType() const;

        virtual std::string getValueSchemaType() const;

    protected:
        virtual bool saveToXML_ParameterByNumber(msparser_internal::ms_XMLHelper &helper, msparser_internal::ms_XMLElement &rootEl) const;

    }; // class ms_quant_parameter


    class MS_MASCOTRESFILE_API ms_quant_parameters: public ms_xml_parameters
    {
        friend class msparser_internal::ms_quant_xmlloader;
    public:
        ms_quant_parameters();

        ms_quant_parameters(const ms_quant_parameters& src);

        virtual ~ms_quant_parameters();

        void defaultValues();

        void copyFrom(const ms_quant_parameters* right);

#ifndef SWIG

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

        virtual std::string getSchemaType() const;

        virtual int getNumberOfParameters() const;

        virtual void clearParameters();

        void appendParameter(const ms_quant_parameter *item);

        const ms_quant_parameter * getParameterByNumber(const int idx) const;

        const ms_quant_parameter * getParameterByName(const char *name) const;

        bool updateParameterByNumber(const int idx, const ms_quant_parameter *param);

        bool updateParameterByName(const char *name, const ms_quant_parameter *param);

        virtual bool deleteParameterByNumber(const int idx);

        virtual bool deleteParameterByName(const char *name);

        virtual std::string getParameterSchemaType() const;

    protected:
        virtual bool saveToXML_Parameters(msparser_internal::ms_XMLHelper &helper, msparser_internal::ms_XMLElement &rootEl) const;

    private:
        typedef std::vector< ms_quant_parameter* > entries_vector;
        entries_vector _entries;

    }; // class ms_quant_parameters
 // end of config_group

} // namespace matrix_science

#endif // MS_QUANT_PARAMETERS_HPP

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