ms_quant_multiplex.hpp

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

#ifndef MS_QUANT_MULTIPLEX_HPP
#define MS_QUANT_MULTIPLEX_HPP


// forward declarations
namespace msparser_internal {
    class ms_quant_xmlloader;
}

namespace matrix_science {

    class ms_xml_schema; // forward declaration



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

        ms_quant_multiplex(const ms_quant_multiplex& src);

        virtual ~ms_quant_multiplex();

        void defaultValues();

        void copyFrom(const ms_quant_multiplex* right);

#ifndef SWIG

        ms_quant_multiplex& operator=(const ms_quant_multiplex& 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 haveIonSeries() const;

        void setIonSeries(const std::string ionSeries);

        void dropIonSeries();

        std::string getIonSeriesSchemaType() const;

        int getNumberOfIonSeries() const;

        void clearIonSeries();

        void appendIonSeries(const std::string ionSeries);

        const std::string getIonSeries(const int idx=0) const;

        bool updateIonSeries(const int idx, const std::string ionSeries);

        bool deleteIonSeries(const int idx);

        bool haveExcludeInternalLabel() const;

        bool isExcludeInternalLabel() const;

        void setExcludeInternalLabel(const bool value);

        void dropExcludeInternalLabel();

        std::string getExcludeInternalLabelSchemaType() const;


        bool haveIonIntensityThreshold() const;

        std::string getIonIntensityThreshold() const;

        void setIonIntensityThreshold(const char* value);

        void dropIonIntensityThreshold();

        std::string getIonIntensityThresholdSchemaType() const;


        bool haveExcludeIsobaricFragments() const;

        bool isExcludeIsobaricFragments() const;

        void setExcludeIsobaricFragments(const bool value);

        void dropExcludeIsobaricFragments();

        std::string getExcludeIsobaricFragmentsSchemaType() const;


        bool haveMinIonPairs() const;

        int getMinIonPairs() const;

        void setMinIonPairs(const int value);

        void dropMinIonPairs();

        std::string getMinIonPairsSchemaType() const;

    private:

        typedef std::vector< std::string > string_vector;
        string_vector _ionSeries;

        bool _excludeInternalLabel;
        bool _excludeInternalLabel_set;

        std::string _ionIntensityThreshold;
        bool _ionIntensityThreshold_set;

        bool _excludeIsobaricFragments;
        bool _excludeIsobaricFragments_set;

        int _minIonPairs;
        bool _minIonPairs_set;
    }; // class ms_quant_multiplex
 // end of config_group

} // namespace matrix_science

#endif // MS_QUANT_MULTIPLEX_HPP

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