ms_wwwoptions.hpp

/*
##############################################################################
# file: ms_wwwoptions.hpp                                                    #
# 'msparser' toolkit                                                         #
# Represents "WWW" section of "mascot.dat" file                              #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2003 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Archive:: /Mowse/ms_mascotresfile/include/ms_wwwoptions.hpp          $ #
#     $Author: villek@matrixscience.com $ #
#       $Date: 2018-07-30 16:23:53 +0100 $ #
#   $Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_2_8_1-0-gea32989045 $ #
# $NoKeywords::                                                            $ #
##############################################################################
*/

#ifndef MS_WWWOPTIONS_HPP
#define MS_WWWOPTIONS_HPP


#include <string>
#include <vector>


namespace matrix_science {
    enum WWW_TYPE
    {
        WWW_SEQ = 0,    
        WWW_REP = 1     
    };


    class MS_MASCOTRESFILE_API ms_wwwentry
    {
        friend class ms_datfile;
        friend class ms_wwwoptions;

    public:
        ms_wwwentry();

        ms_wwwentry(const ms_wwwentry& src);
        
        ~ms_wwwentry();

        void defaultValues();

        void copyFrom(const ms_wwwentry* right);

#ifndef SWIG

        ms_wwwentry& operator=(const ms_wwwentry& right);
#endif

        std::string getName() const;

        void setName(const char* value);

        WWW_TYPE getType() const;

        void setType(const WWW_TYPE value);

        int getParseRule() const;

        void setParseRule(const int value);

        std::string getHostName() const;

        void setHostName(const char* value);

        int getPortNumber() const;

        void setPortNumber(const int value);

        std::string getPath() const;

        void setPath(const char* value);

    private:
        std::string name_;
        WWW_TYPE type_;
        int parseRuleNum_;
        std::string hostName_;
        int portNumber_;
        std::string path_;

        std::string getStringName() const;
        std::string getStringValue() const;
    }; // class MS_MASCOTRESFILE_API ms_wwwentry


    class MS_MASCOTRESFILE_API ms_wwwoptions: public ms_customproperty
    {
        friend class ms_datfile;
    public:

        ms_wwwoptions();

        ms_wwwoptions(const ms_wwwoptions& src);

        ~ms_wwwoptions();

        void defaultValues();

        void copyFrom(const ms_wwwoptions* right);

#ifndef SWIG

        ms_wwwoptions& operator=(const ms_wwwoptions& right);
#endif

        bool isSectionAvailable() const;

        void setSectionAvailable(const bool value);

        int getNumberOfEntries() const;

        const ms_wwwentry* getEntry(const int index) const;

        const ms_wwwentry* getSeqEntryByName(const char* dbName) const;
        
        const ms_wwwentry* getRepEntryByName(const char* dbName) const;

        void clearEntries();
        
        void appendEntry(const ms_wwwentry* item);

        void setEntry(const int index, const ms_wwwentry* item);

        void dropEntry(const int index);

#ifdef SUPPRESS_MS_CUSTOMPROPERTY_INHERITANCE
#include "suppress_ms_customproperty.hpp"
#endif

    private:
        bool sectionAvailable_;
        std::vector< ms_wwwentry* > entries_;
    }; // class ms_wwwoptions // end of config_group
} // namespace matrix_science

#endif // MS_WWWOPTIONS_HPP