ms_crosslinking_linker.hpp

/*
##############################################################################
# file: ms_crosslinking_linker.hpp                                           #
# 'msparser' toolkit                                                         #
# Encapsulates linker element in crosslinking.xml                            #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2019 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_crosslinking_linker.hpp $
 * @(#)$Revision: 5a6646e705a1dce6cb8493dec184ed46d0bd6c08 | MSPARSER_REL_2_8_1-0-gea32989045 $
 * @(#)$Date: 2019-10-18 16:39:04 +0100 $
##############################################################################
 */

#ifndef MS_CROSSLINKING_LINKER_HPP
#define MS_CROSSLINKING_LINKER_HPP


#include <string>

// forward declarations
namespace msparser_internal {
    class ms_crosslinking_xmlloader;
}

namespace matrix_science {
    class ms_crosslinking_monolink;
    class ms_crosslinking_does_not_pair_with;
    class ms_xml_schema; // forward declaration



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

    public:
        ms_crosslinking_linker();

        ms_crosslinking_linker(const ms_crosslinking_linker& src);

        virtual ~ms_crosslinking_linker();

        void defaultValues();

        void copyFrom(const ms_crosslinking_linker* right);

#ifndef SWIG

        ms_crosslinking_linker& operator=(const ms_crosslinking_linker& 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 haveModFileName() const;

        std::string getModFileName() const;

        void setModFileName(const char* value);

        void dropModFileName();

        std::string getModFileNameSchemaType() const;


        int getNumberOfMonoLinks() const;

        void clearMonoLinks();

        void appendMonoLink(const ms_crosslinking_monolink *item);

        const ms_crosslinking_monolink * getMonoLinkByNumber(const int idx) const;

        bool updateMonoLinkByNumber(const int idx, const ms_crosslinking_monolink* monolink);

        bool deleteMonoLinkByNumber(const int idx);

        std::string getMonoLinkSchemaType() const;


        int getNumberOfDoesNotPairWiths() const;

        void clearDoesNotPairWiths();

        void appendDoesNotPairWith(const ms_crosslinking_does_not_pair_with *item);

        const ms_crosslinking_does_not_pair_with * getDoesNotPairWithByNumber(const int idx) const;

        bool updateDoesNotPairWithByNumber(const int idx, const ms_crosslinking_does_not_pair_with* does_not_pair_with);

        bool deleteDoesNotPairWithByNumber(const int idx);

        std::string getDoesNotPairWithSchemaType() const;

    private:
        typedef std::vector< ms_crosslinking_monolink * > monolink_vector;
        monolink_vector _monolinks;

        typedef std::vector< ms_crosslinking_does_not_pair_with * > does_not_pair_with_vector;
        does_not_pair_with_vector _does_not_pair_withs;

        std::string _modFileName;
        bool _modFileName_set;

    }; // class ms_crosslinking_linker
 // end of config_group

} // namespace matrix_science

#endif // MS_CROSSLINKING_LINKER_HPP

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