ms_quant_localdef.hpp

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

#ifndef MS_QUANT_LOCALDEF_HPP
#define MS_QUANT_LOCALDEF_HPP


#include <string>
#include <vector>

// forward declarations
namespace msparser_internal {
    class ms_quant_xmlloader;
}

namespace matrix_science {

    class ms_quant_specificity; // forward declaration
    class ms_quant_composition; // forward declaration
    class ms_xml_schema; // forward declaration


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

    public:
        ms_quant_localdef();

        ms_quant_localdef(const ms_quant_localdef& src);

        virtual ~ms_quant_localdef();

        void defaultValues();

        void copyFrom(const ms_quant_localdef* right);

#ifndef SWIG

        ms_quant_localdef& operator=(const ms_quant_localdef& 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 getNumberOfSpecificities() const;

        void clearSpecificities();

        void appendSpecificity(const ms_quant_specificity *specificity);

        const ms_quant_specificity * getSpecificity(const int idx) const;

        bool updateSpecificity(const int idx, const ms_quant_specificity* specificity);

        bool deleteSpecificity(const int idx);

        std::string getSpecificitySchemaType() const;


        bool haveDelta() const;

        const ms_quant_composition* getDelta() const;

        void setDelta(const ms_quant_composition *delta);

        void dropDelta();

        std::string getDeltaSchemaType() const;


        int getNumberOfIgnores() const;

        void clearIgnores();

        void appendIgnore(const ms_quant_composition *ignore);

        const ms_quant_composition * getIgnore(const int idx) const;

        bool updateIgnore(const int idx, const ms_quant_composition* ignore);

        bool deleteIgnore(const int idx);

        std::string getIgnoreSchemaType() const;


        bool haveTitle() const;

        std::string getTitle() const;

        void setTitle(const char* value);

        void dropTitle();

        std::string getTitleSchemaType() const;


    private:
        // elements
        typedef std::vector< ms_quant_specificity* > specificity_vector;
        specificity_vector _specificities;

        ms_quant_composition* _pDelta;
        bool _delta_set;

        typedef std::vector< ms_quant_composition* > composition_vector;
        composition_vector _ignores;

        // attributes
        std::string _title;
        bool _title_set;

    }; // class ms_quant_localdef
 // end of config_group

} // namespace matrix_science

#endif // MS_QUANT_LOCALDEF_HPP

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