ms_quant_specificity.hpp

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

#ifndef MS_QUANT_SPECIFICITY_HPP
#define MS_QUANT_SPECIFICITY_HPP


#include <string>
#include <vector>

// forward declarations
namespace msparser_internal {
    class ms_quant_xmlloader;
}

namespace matrix_science {

    class ms_quant_neutralloss; // forward declaration
    class ms_quant_pepneutralloss; // forward declaration
    class ms_xml_schema; // forward declaration



    class MS_MASCOTRESFILE_API ms_quant_specificity: public ms_xml_IValidatable // defined in "ms_xml_typeinfo.hpp"
    {
        friend class msparser_internal::ms_quant_xmlloader;

    public:
        ms_quant_specificity();

        ms_quant_specificity(const ms_quant_specificity& src);

        virtual ~ms_quant_specificity();

        void defaultValues();

        void copyFrom(const ms_quant_specificity* right);

#ifndef SWIG

        ms_quant_specificity& operator=(const ms_quant_specificity& right);
#endif
        // methods of ms_quant_IValidatable interface

        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 getNumberOfNeutralLosses() const;

        void clearNeutralLosses();

        void appendNeutralLoss(const ms_quant_neutralloss *neutralloss);

        const ms_quant_neutralloss * getNeutralLoss(const int idx) const;

        bool updateNeutralLoss(const int idx, const ms_quant_neutralloss* neutralloss);

        bool deleteNeutralLoss(const int idx);

        std::string getNeutralLossSchemaType() const;


        int getNumberOfPepNeutralLosses() const;

        void clearPepNeutralLosses();

        void appendPepNeutralLoss(const ms_quant_pepneutralloss *neutralloss);

        const ms_quant_pepneutralloss* getPepNeutralLoss(const int idx) const;

        bool updatePepNeutralLoss(const int idx, const ms_quant_pepneutralloss* neutralloss);

        bool deletePepNeutralLoss(const int idx);

        std::string getPepNeutralLossSchemaType() const;


        bool haveSite() const;

        std::string getSite() const;

        void setSite(const char* site);

        void dropSite();

        std::string getSiteSchemaType() const;


        bool havePosition() const;

        std::string getPosition() const;

        void setPosition(const char* position);

        void dropPosition();

        std::string getPositionSchemaType() const;

    private:
        typedef std::vector< ms_quant_neutralloss* > neutralloss_vector;
        neutralloss_vector _neutrallosses;
        
        typedef std::vector< ms_quant_pepneutralloss* > pepneutralloss_vector;
        pepneutralloss_vector _pepneutrallosses;

        std::string _site;
        bool _site_set;

        std::string _position;
        bool _position_set;
    }; // class ms_quant_specificity
 // end of config_group

} // namespace matrix_science

#endif // MS_QUANT_SPECIFICITY_HPP

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