ms_crosslinking_method.hpp

/*
##############################################################################
# file: ms_crosslinking_method.hpp                                           #
# 'msparser' toolkit                                                         #
# Represents a method object in crosslinking.xml file                        #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2019 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_crosslinking_method.hpp $
 * @(#)$Revision: 20373858f9250b373e137e3d5de4992e9e7d19e6 | MSPARSER_REL_2_8_1-0-gea32989045 $
 * @(#)$Date: 2019-01-08 14:42:05 +0000 $
##############################################################################
 */

#ifndef MS_CROSSLINKING_METHOD_HPP
#define MS_CROSSLINKING_METHOD_HPP


#include <string>
#include <vector>

// forward declarations
namespace msparser_internal {
    class ms_crosslinking_xmlloader;
}

namespace matrix_science {
    class ms_crosslinking_linkers; // forward declaration
    class ms_crosslinking_accessions; // forward declaration
    class ms_crosslinking_scope; // forward declaration
    class ms_crosslinking_filters; // forward declaration
    class ms_crosslinking_settings; // forward declaration
    class ms_crosslinking_configfile; // forward declaration
    class ms_xml_schema; // forward declaration



    class MS_MASCOTRESFILE_API ms_crosslinking_method: public ms_xml_IValidatable
    {
        friend class msparser_internal::ms_crosslinking_xmlloader;
        friend class ms_crosslinking_configfile;

    public:
        ms_crosslinking_method();

        ms_crosslinking_method(const ms_crosslinking_method& src);

        virtual ~ms_crosslinking_method();

        void defaultValues();

        void copyFrom(const ms_crosslinking_method* right);

#ifndef SWIG

        ms_crosslinking_method& operator=(const ms_crosslinking_method& 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 haveName() const;

        std::string getName() const;

        void setName(const char* value);

        void dropName();

        std::string getNameSchemaType() const;


        bool haveDescription() const;

        std::string getDescription() const;

        void setDescription(const char* value);

        void dropDescription();

        std::string getDescriptionSchemaType() const;


        bool haveStrategy() const;

        std::string getStrategy() const;

        void setStrategy(const char* value);

        void dropStrategy();

        std::string getStrategySchemaType() const;


        bool haveLinkers() const;

        const ms_crosslinking_linkers* getLinkers() const;

        void setLinkers(const ms_crosslinking_linkers* linkers);

        void dropLinkers();

        std::string getLinkersSchemaType() const;


        bool haveAccessions() const;

        const ms_crosslinking_accessions* getAccessions() const;

        void setAccessions(const ms_crosslinking_accessions* accessions);

        void dropAccessions();

        std::string getAccessionsSchemaType() const;


        bool haveScope() const;

        const ms_crosslinking_scope* getScope() const;

        void setScope(const ms_crosslinking_scope* scope);

        void dropScope();

        std::string getScopeSchemaType() const;


        bool haveFilters() const;

        const ms_crosslinking_filters* getFilters() const;

        void setFilters(const ms_crosslinking_filters* filters);

        void dropFilters();

        std::string getFiltersSchemaType() const;


        bool haveSettings() const;

        const ms_crosslinking_settings* getSettings() const;

        void setSettings(const ms_crosslinking_settings* settings);

        void dropSettings();

        std::string getSettingsSchemaType() const;


    private:
        std::string _name;
        bool _name_set;

        std::string _strategy;
        bool _strategy_set;

        std::string _description;
        bool _description_set;

        ms_crosslinking_linkers *_pLinkers;
        ms_crosslinking_accessions *_pAccessions;
        ms_crosslinking_scope *_pScope;
        ms_crosslinking_filters *_pFilters;
        ms_crosslinking_settings *_pSettings;

    }; // class ms_crosslinking_method
 // end of config_group

} // namespace matrix_science

#endif // MS_CROSSLINKING_METHOD_HPP

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