ParameterSet.h

Go to the documentation of this file.

#ifndef _PARAMETER_SET_H
#define _PARAMETER_SET_H
/*******************************************************************************
*    ALMA - Atacama Large Millimiter Array
*    (c) Associated Universities Inc., 2002 
*    (c) European Southern Observatory, 2002
*    Copyright by ESO (in the framework of the ALMA collaboration)
*    and Cosylab 2002, All rights reserved
*
*    This library is free software; you can redistribute it and/or
*    modify it under the terms of the GNU Lesser General Public
*    License as published by the Free Software Foundation; either
*    version 2.1 of the License, or (at your option) any later version.
*
*    This library is distributed in the hope that it will be useful,
*    but WITHOUT ANY WARRANTY; without even the implied warranty of
*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
*    Lesser General Public License for more details.
*
*    You should have received a copy of the GNU Lesser General Public
*    License along with this library; if not, write to the Free Software
*    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*
* "@(#) $Id: ParameterSet.h,v 1.12 2010/04/27 12:20:58 htischer Exp $"
*
* who       when      what
* --------  --------  ----------------------------------------------
* sharring  09/27/04  created
*/

#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif

#include <map>
#include <memory>
#include <string.h>
#include <stdexcept>
#include <stdlib.h>
#include <xercesc/dom/DOMBuilder.hpp>
#include <xercesc/dom/DOMElement.hpp>
#include <xercesc/dom/DOMNode.hpp>
#include <xercesc/util/PlatformUtils.hpp>
#include <ParamStrX.h>
#include <InMemoryXmlData.h>
#include <ParamSetDef.h>
#include <BoolParam.h>
#include <IntParam.h>
#include <IntArrayParam.h>
#include <DoubleArrayParam.h>
#include <DoubleParam.h>
#include <StringParam.h>
#include <StringArrayParam.h>
#include <parameterConstants.h>

using std::auto_ptr;
using std::domain_error;
using std::invalid_argument;
using std::map;
using std::string;
using XERCES_CPP_NAMESPACE_QUALIFIER DOMElement;
using XERCES_CPP_NAMESPACE_QUALIFIER DOMNodeList;
using XERCES_CPP_NAMESPACE_QUALIFIER DOMBuilder;

namespace Parameters {

        class ParameterSet
        {    
                public:
                        /********************** Constructors/Destructors ***************************/

                        ParameterSet(string xmlFileName);

                        ParameterSet(InMemoryXmlData  * fileInfo);

                        virtual ~ParameterSet();

                        /*************************** getters ***************************************/

                        IntParam getIntParam(string paramName);

                        DoubleParam getDoubleParam(string paramName);

                        StringParam getStringParam(string paramName);

                        BoolParam  getBoolParam(string paramName);

                        IntArrayParam getIntArrayParam(string paramName);

                        DoubleArrayParam getDoubleArrayParam(string paramName);

                        StringArrayParam getStringArrayParam(string paramName);

                        /*************************** setters ***************************************/

                        void setParam(string paramName, IntParam value);

                        void setParam(string paramName, DoubleParam value);

                        void setParam(string paramName, StringParam value);

                        void setParam(string paramName, BoolParam value);

                        void setParam(string paramName, IntArrayParam value);

                        void setParam(string paramName, DoubleArrayParam value);

                        void setParam(string paramName, StringArrayParam value);

                        ParamSetDef* getParamSetDef();          

                        string getName();

                        string toString();

                private:

                        void setName(string psetName);

                        string getParamSetDefFileName();

                        void validate();

                        void validateBoolParams();
                        void validateBoolParam(BoolParamDef pDef);

                        void validateIntParams();
                        void validateIntParam(IntParamDef pDef);

                        void validateDoubleParams();
                        void validateDoubleParam(DoubleParamDef pDef);

                        void validateStringParams();
                        void validateStringParam(StringParamDef pDef);

                        void validateIntArrayParams();
                        void validateIntArrayParam(IntArrayParamDef pDef);

                        void validateStringArrayParams();
                        void validateStringArrayParam(StringArrayParamDef pDef);

                        void validateDoubleArrayParams();
                        void validateDoubleArrayParam(DoubleArrayParamDef pDef);

                        int parseDOM(const char* xmlParamSet, InMemoryXmlData * fileInfo);
                        int parseFile(const string & xmlFile);
                        int parseSAX(const string & xmlParamSet);
                        void handleBoolParam(DOMElement *paramElem);
                        void handleIntParam(DOMElement *paramElem);
                        void handleIntArrayParam(DOMElement *paramElem);
                        void handleDoubleParam(DOMElement *paramElem);
                        void handleDoubleArrayParam(DOMElement *paramElem);
                        void handleStringParam(DOMElement *paramElem);
                        void handleStringArrayParam(DOMElement *paramElem);
                        void processParamNodes(DOMNodeList *paramNodes);
                        void initialize();
                        void setSchemaLocation(DOMBuilder * parser);

                        string name;
                        string psetDefFileName;
                        map<string, IntParam> intParamMap;
                        map<string, IntArrayParam> intArrayParamMap;
                        map<string, DoubleParam> doubleParamMap;
                        map<string, DoubleArrayParam> doubleArrayParamMap;
                        map<string, StringParam> stringParamMap;
                        map<string, StringArrayParam> stringArrayParamMap;
                        map<string, BoolParam> boolParamMap;

                        // Constants
                        XMLCh* PSETDEF_TAG_NAME;
                        XMLCh* PARAMETER_TAG_NAME;
                        XMLCh* NAME_TAG_NAME;
                        XMLCh* VALUE_TAG_NAME;
                        XMLCh* UNITS_TAG_NAME;

                        XMLCh* INT_PARAM_TYPE;
                        XMLCh* DOUBLE_PARAM_TYPE;
                        XMLCh* STRING_PARAM_TYPE;
                        XMLCh* BOOL_PARAM_TYPE;
                        XMLCh* INT_ARRAY_PARAM_TYPE;
                        XMLCh* DOUBLE_ARRAY_PARAM_TYPE;
                        XMLCh* STRING_ARRAY_PARAM_TYPE;

                        auto_ptr<ParamSetDef> ParameterSetDef;
        };

}
#endif