ms_xml_parameters.hpp

/*
##############################################################################
# file: ms_xml_parameters.hpp                                                #
# 'msparser' toolkit                                                         #
# Base class for parameterType-definitions                                   #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2019 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_xml_parameters.hpp $
 * @(#)$Revision: 8fee77726a13a239ca8bcf2b46212bff297db9b7 | MSPARSER_REL_3_1_0-2025-07-27-0-gea47708fac $
 * @(#)$Date: 2018-12-20 10:50:55 +0000 $
##############################################################################
 */
 
#ifndef MS_XML_PARAMETERS_HPP
#define MS_XML_PARAMETERS_HPP
 
 
#include <string>
#include <vector>
 
namespace msparser_internal {
    class ms_xml_xmlloader;
    class ms_XMLHelper;
    class ms_XMLElement;
}
 
namespace matrix_science {
    class ms_xml_schema; // forward declaration
 
 
    class MS_MASCOTRESFILE_API ms_xml_parameter: public ms_xml_IValidatable
    {
    public:
        ms_xml_parameter();
 
        ms_xml_parameter(const ms_xml_parameter& src);
 
        virtual ~ms_xml_parameter();
 
        void defaultValues();
 
        void copyFrom(const ms_xml_parameter* right);
 
#ifndef SWIG
        ms_xml_parameter& operator=(const ms_xml_parameter& right);
#endif
        virtual std::string getSchemaType() const = 0;
 
        std::string validateShallow(const ms_xml_schema *pSchemaFileObj) const;
 
        std::string validateDeep(const ms_xml_schema *pSchemaFileObj) const;
 
 
        bool haveName() const;
 
        std::string getName() const;
 
        void setName(const char* value);
 
        void dropName();
 
        virtual std::string getNameSchemaType() const = 0;
 
 
        bool haveDescription() const;
 
        std::string getDescription() const;
 
        void setDescription(const char* value);
 
        void dropDescription();
 
        virtual std::string getDescriptionSchemaType() const = 0;
 
 
        std::string getValue() const;
 
        void setValue(const char* value);
 
        virtual std::string getValueSchemaType() const = 0;
 
    protected:
        virtual bool saveToXML_ParameterByNumber(msparser_internal::ms_XMLHelper &helper, msparser_internal::ms_XMLElement &rootEl) const = 0;
 
        std::string _name;
        bool _name_set;
 
        std::string _description;
        bool _description_set;
 
        std::string _value;
 
    }; // class ms_xml_parameter
 
 
    class MS_MASCOTRESFILE_API ms_xml_parameters: public ms_xml_IValidatable
    {
    public:
        ms_xml_parameters();
 
        ms_xml_parameters(const ms_xml_parameters& src);
 
        virtual ~ms_xml_parameters();
 
        void defaultValues();
 
        virtual std::string getSchemaType() const = 0;
 
        std::string validateShallow(const ms_xml_schema *pSchemaFileObj) const;
 
        std::string validateDeep(const ms_xml_schema *pSchemaFileObj) const;
 
 
        virtual int getNumberOfParameters() const = 0;
 
        virtual void clearParameters() = 0;
 
        virtual bool deleteParameterByNumber(const int idx) = 0;
 
        virtual bool deleteParameterByName(const char *name) = 0;
 
        virtual std::string getParameterSchemaType() const = 0;
 
    protected:
        virtual bool saveToXML_Parameters(msparser_internal::ms_XMLHelper &helper, msparser_internal::ms_XMLElement &rootEl) const = 0;
 
    }; // class ms_xml_parameters
 // end of config_group
 
} // namespace matrix_science
 
#endif // MS_XML_PARAMETERS_HPP
 
/*------------------------------- End of File -------------------------------*/