ms_crosslinking_linkers.hpp

/*
##############################################################################
# file: ms_crosslinking_linkers.hpp                                          #
# 'msparser' toolkit                                                         #
# Encapsulates linkers element in crosslinking.xml                           #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2019 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_crosslinking_linkers.hpp $
 * @(#)$Revision: 9de60354aaae13272cadfa764dbabd92c93c724c | MSPARSER_REL_2_8_1-0-gea32989045 $
 * @(#)$Date: 2018-12-20 12:05:22 +0000 $
##############################################################################
 */

#ifndef MS_CROSSLINKING_LINKERS_HPP
#define MS_CROSSLINKING_LINKERS_HPP


#include <string>

// forward declarations
namespace msparser_internal {
    class ms_crosslinking_xmlloader;
}

namespace matrix_science {
    class ms_crosslinking_linker;
    class ms_xml_schema; // forward declaration



    class MS_MASCOTRESFILE_API ms_crosslinking_linkers: public ms_xml_IValidatable
    {
        friend class msparser_internal::ms_crosslinking_xmlloader;

    public:
        ms_crosslinking_linkers();

        ms_crosslinking_linkers(const ms_crosslinking_linkers& src);

        virtual ~ms_crosslinking_linkers();

        void defaultValues();

        void copyFrom(const ms_crosslinking_linkers* right);

#ifndef SWIG

        ms_crosslinking_linkers& operator=(const ms_crosslinking_linkers& 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 getNumberOfLinkers() const;

        void clearLinkers();

        void appendLinker(const ms_crosslinking_linker *item);

        const ms_crosslinking_linker * getLinkerByNumber(const int idx) const;

        bool updateLinkerByNumber(const int idx, const ms_crosslinking_linker* linker);

        bool deleteLinkerByNumber(const int idx);

        std::string getLinkerSchemaType() const;

    private:
        typedef std::vector< ms_crosslinking_linker * > linker_vector;
        linker_vector _linkers;

    }; // class ms_crosslinking_linkers
 // end of config_group

} // namespace matrix_science

#endif // MS_CROSSLINKING_LINKERS_HPP

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