ms_umod_elemref.hpp

/*
##############################################################################
# file: ms_umod_elemref.hpp                                                  #
# 'msparser' toolkit                                                         #
# Represents 'elemref_t' type in unimod.xml file                             #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2006 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_umod_elemref.hpp $
 * @(#)$Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_2_8_1-0-gea32989045 $
 * @(#)$Date: 2018-07-30 16:23:53 +0100 $
##############################################################################
 */

#ifndef MS_UMOD_ELEMREF_HPP
#define MS_UMOD_ELEMREF_HPP


#include <string>
#include <vector>

// forward declarations
namespace msparser_internal {
    class ms_umod_xmlloader;
}

namespace matrix_science {

    class ms_quant_element; // forward declaration;
    class ms_xml_schema; // forward declaration



    class MS_MASCOTRESFILE_API ms_umod_elemref: public ms_xml_IValidatable
    {
        friend class msparser_internal::ms_umod_xmlloader;
        friend class ms_umod_configfile;

    public:
        ms_umod_elemref();

        ms_umod_elemref(const ms_umod_elemref& src);

        ms_umod_elemref(const ms_quant_element& src);


        virtual ~ms_umod_elemref();

        void defaultValues();

        void copyFrom(const ms_umod_elemref* right);

        void copyFrom(const ms_quant_element* right);

#ifndef SWIG

        ms_umod_elemref& operator=(const ms_umod_elemref& 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 haveSymbol() const;

        std::string getSymbol() const;

        void setSymbol(const char* value);

        void dropSymbol();

        std::string getSymbolSchemaType() const;


        bool haveNumber() const;

        int getNumber() const;

        void setNumber(const int value);

        void dropNumber();

        std::string getNumberSchemaType() const;

    private:

        std::string _symbol;
        bool _symbol_set;

        int _number;
        bool _number_set;
    }; // class ms_umod_elemref
 // end of config_group

} // namespace matrix_science

#endif // MS_UMOD_ELEMREF_HPP

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