ms_umod_neutralloss.hpp

/*
##############################################################################
# file: ms_umod_neutralloss.hpp                                              #
# 'msparser' toolkit                                                         #
# Represents 'NeutralLoss' element in unimod.xml file                        #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2006 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_umod_neutralloss.hpp $
 * @(#)$Revision: 0bb105c754f1d83ce7437808601186f321028555 | MSPARSER_REL_2_8_1-0-gea32989045 $
 * @(#)$Date: 2019-04-17 12:17:44 +0100 $
##############################################################################
 */

#ifndef MS_UMOD_NEUTRALLOSS_HPP
#define MS_UMOD_NEUTRALLOSS_HPP


#include <string>
#include <vector>

// forward declarations
namespace msparser_internal {
    class ms_umod_xmlloader;
}

namespace matrix_science {

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



    class MS_MASCOTRESFILE_API ms_umod_neutralloss: public ms_umod_composition
    {
        friend class msparser_internal::ms_umod_xmlloader;

    public:
        ms_umod_neutralloss();

        ms_umod_neutralloss(const ms_umod_neutralloss& src);

        ms_umod_neutralloss(const ms_quant_neutralloss& src, const ms_umod_configfile& umodFile);

        ms_umod_neutralloss(const ms_quant_pepneutralloss& src, const ms_umod_configfile& umodFile);

        virtual ~ms_umod_neutralloss();

        void defaultValues();

        void copyFrom(const ms_umod_neutralloss* right);

        void copyFrom(const ms_quant_neutralloss* right, const ms_umod_configfile& umodFile);

        void copyFrom(const ms_quant_pepneutralloss* right, const ms_umod_configfile& umodFile);

#ifndef SWIG

        ms_umod_neutralloss& operator=(const ms_umod_neutralloss& 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 haveFlag() const;

        bool isFlag() const;

        void setFlag(const bool value);

        void dropFlag();

        std::string getFlagSchemaType() const;


        bool haveCode() const;

        std::string getCode() const;

        void setCode(const char* value);

        void dropCode();

        std::string getCodeSchemaType() const;


        bool havePairsWith() const;

        std::string getPairsWith() const;

        void setPairsWith(const char* value);

        void dropPairsWith();

        std::string getPairsWithSchemaType() const;


        bool haveDescription() const;

        std::string getDescription() const;

        void setDescription(const char* value);

        void dropDescription();

        std::string getDescriptionSchemaType() const;

    private:

        bool _flag;
        bool _flag_set;
        
        std::string _code;
        bool _code_set;
        
        std::string _pairsWith;
        bool _pairsWith_set;
        
        std::string _description;
        bool _description_set;
    }; // class ms_umod_neutralloss
 // end of config_group

} // namespace matrix_science

#endif // MS_UMOD_NEUTRALLOSS_HPP

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