ms_umod_modbrick.hpp

/*
##############################################################################
# file: ms_umod_modbrick.hpp                                                #
# 'msparser' toolkit                                                         #
# Represents modbrick object from unimod.xml file                        #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2006 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_umod_modbrick.hpp $
 * @(#)$Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
 * @(#)$Date: 2018-07-30 16:23:53 +0100 $
##############################################################################
 */
 
#ifndef MS_UMOD_MODBRICK_HPP
#define MS_UMOD_MODBRICK_HPP
 
 
#include <string>
#include <vector>
 
// forward declarations
namespace msparser_internal {
    class ms_umod_xmlloader;
}
 
namespace matrix_science {
 
    class ms_umod_elemref; // forward declaration
    class ms_xml_schema; // forward declaration
 
    class MS_MASCOTRESFILE_API ms_umod_modbrick: public ms_xml_IValidatable
    {
        friend class msparser_internal::ms_umod_xmlloader;
        friend class ms_umod_configfile;
 
    public:
        ms_umod_modbrick();
 
        ms_umod_modbrick(const ms_umod_modbrick& src);
 
        virtual ~ms_umod_modbrick();
 
        void defaultValues();
 
        void copyFrom(const ms_umod_modbrick* right);
 
#ifndef SWIG
        ms_umod_modbrick& operator=(const ms_umod_modbrick& 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 getNumberOfElemRefs() const;
 
        void clearElemRefs();
 
        void appendElemRef(const ms_umod_elemref *elemref);
 
        const ms_umod_elemref* getElemRef(const int idx) const;
 
        bool updateElemRef(const int idx, const ms_umod_elemref *elemref);
 
        bool deleteElemRef(const int idx);
 
        std::string getElemRefSchemaType() const;
 
 
        bool haveTitle() const;
 
        std::string getTitle() const;
 
        void setTitle(const char* value);
 
        void dropTitle();
 
        std::string getTitleSchemaType() const;
 
 
        bool haveFullName() const;
 
        std::string getFullName() const;
 
        void setFullName(const char* value);
 
        void dropFullName();
 
        std::string getFullNameSchemaType() const;
 
 
        bool haveAvgeMass() const;
 
        double getAvgeMass() const;
 
        void setAvgeMass(const double value);
 
        void dropAvgeMass();
 
        std::string getAvgeMassSchemaType() const;
 
 
        bool haveMonoMass() const;
 
        double getMonoMass() const;
 
        void setMonoMass(const double value);
 
        void dropMonoMass();
 
        std::string getMonoMassSchemaType() const;
 
    private:
 
        typedef std::vector< ms_umod_elemref* > elemref_vector;
        elemref_vector _elemRefs;
 
        std::string _title;
        bool _title_set;
 
        std::string _fullName;
        bool _fullName_set;
 
        double _avgeMass;
        bool _avgeMass_set;
 
        double _monoMass;
        bool _monoMass_set;
    }; // class ms_umod_modbrick
 // end of config_group
 
} // namespace matrix_science
 
#endif // MS_UMOD_MODBRICK_HPP
 
/*------------------------------- End of File -------------------------------*/