ms_taxonomyfile.hpp

/*
##############################################################################
# file: ms_taxonomyfile.hpp                                                  #
# 'msparser' toolkit                                                         #
# Encapsulates "taxonomy"-file that available taxonomy choices               #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2004 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Archive:: /Mowse/ms_mascotresfile/include/ms_taxonomyfile.hpp        $ #
#     $Author: villek@matrixscience.com $ #
#       $Date: 2018-07-30 16:23:53 +0100 $ #
#   $Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $ #
# $NoKeywords::                                                            $ #
##############################################################################
*/
 
#ifndef MS_TAXONOMYFILE_HPP
#define MS_TAXONOMYFILE_HPP
 
 
#include <string>
#include <vector>
 
namespace matrix_science {
 
    class MS_MASCOTRESFILE_API ms_taxonomychoice: public ms_customproperty
    {
        friend class ms_taxonomyfile;
    public:
 
        ms_taxonomychoice();
 
        ms_taxonomychoice(const ms_taxonomychoice& src);
 
        ~ms_taxonomychoice();
 
        void defaultValues();
 
        void copyFrom(const ms_taxonomychoice* src);
 
#ifndef SWIG
        ms_taxonomychoice& operator=(const ms_taxonomychoice& right);
#endif
        std::string getTitle() const;
 
        void setTitle(const char* value);
 
        int getNumberOfIncludeTaxonomies() const;
 
        int getIncludeTaxonomy(const int n) const;
 
        void clearIncludeTaxonomies();
 
        void appendIncludeTaxonomy(const int id);
 
        int getNumberOfExcludeTaxonomies() const;
 
        int getExcludeTaxonomy(const int n) const;
 
        void clearExcludeTaxonomies();
 
        void appendExcludeTaxonomy(const int id);
 
#ifdef SUPPRESS_MS_CUSTOMPROPERTY_INHERITANCE
#include "suppress_ms_customproperty.hpp"
#endif
 
    private:
        void setCustomProperty();
 
    private:
        std::string title;
 
        std::vector< int > includeList;
        std::vector< int > excludeList;
    }; // ms_taxonomychoice
 
    class ms_filesource;
 
 
    class MS_MASCOTRESFILE_API ms_taxonomyfile: public ms_errors
    {
    public:
        ms_taxonomyfile();
 
        ms_taxonomyfile(const ms_taxonomyfile& src);
 
        ms_taxonomyfile(const char* filename, const matrix_science::ms_connection_settings * cs = 0); 
 
        ~ms_taxonomyfile();
 
        void defaultValues();
 
        void copyFrom(const ms_taxonomyfile* right);
 
#ifndef SWIG
        ms_taxonomyfile& operator=(const ms_taxonomyfile& right);
#endif
        void setFileName(const char* name);
 
        std::string getFileName() const;
 
 
        void setConnectionSettings(const matrix_science::ms_connection_settings & cs);
 
 
        matrix_science::ms_connection_settings getConnectionSettings() const;
 
        void read_file();
 
        void read_buffer(const char* buffer);
 
        void save_file();
 
        int getNumberOfEntries() const;
 
        void clearEntries();
 
        void appendEntry(const ms_taxonomychoice* item);
 
        const ms_taxonomychoice * getEntryByNumber(const int index) const;
 
        ms_taxonomychoice * getEntryByName(const char* name);
 
    private:
        void read_internal(ms_filesource *pFSource);
 
        typedef std::vector<ms_taxonomychoice* > entries_vector;
        entries_vector  entries;
 
        std::string     filename_;
        std::vector< std::string > comments_;
        ms_connection_settings cs_;
    }; // ms_taxonomyfile // end of config_group
} // namespace matrix_science
 
#endif // MS_TAXONOMYFILE_HPP
 
/*------------------------------- End of File -------------------------------*/