itom 2.0.0
D:/git-itom/sources/itom/Qitom/helper/paramHelper.h
00001 /* ********************************************************************
00002     itom software
00003     URL: http://www.uni-stuttgart.de/ito
00004     Copyright (C) 2013, Institut für Technische Optik (ITO),
00005     Universität Stuttgart, Germany
00006 
00007     This file is part of itom.
00008   
00009     itom is free software; you can redistribute it and/or modify it
00010     under the terms of the GNU Library General Public Licence as published by
00011     the Free Software Foundation; either version 2 of the Licence, or (at
00012     your option) any later version.
00013 
00014     itom is distributed in the hope that it will be useful, but
00015     WITHOUT ANY WARRANTY; without even the implied warranty of
00016     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library
00017     General Public Licence for more details.
00018 
00019     You should have received a copy of the GNU Library General Public License
00020     along with itom. If not, see <http://www.gnu.org/licenses/>.
00021 *********************************************************************** */
00022 
00023 #ifndef PARAMHELPER_H
00024 #define PARAMHELPER_H
00025 
00026 #include "../../common/sharedStructures.h"
00027 
00028 #include <qmap.h>
00029 #include <qstring.h>
00030 #include <qsharedpointer.h>
00031 
00032 namespace ito 
00033 {
00034     class AddInBase; //forward declaration
00035 
00036     class ParamHelper
00037     {
00038     public: 
00039 
00040         static tCompareResult compareParam(const ito::Param &paramTemplate, const ito::Param &param, ito::RetVal &ret);
00041         static tCompareResult compareMetaParam(const ito::ParamMeta *metaTemplate, const ito::ParamMeta *meta, const char* nameTemplate, const char *name, ito::RetVal &ret);
00042 
00043         static ito::RetVal validateStringMeta(const ito::StringMeta *meta, const char* value, bool mandatory = false);
00044         static ito::RetVal validateDoubleMeta(const ito::DoubleMeta *meta, double value);
00045         static ito::RetVal validateDoubleMetaAndRoundToStepSize(const ito::DoubleMeta *meta, ito::ParamBase &doubleParam, bool allowRounding = true);
00046         static ito::RetVal validateDoubleMetaAndRoundToStepSize(const ito::DoubleMeta *meta, double &value, bool allowRounding = true);
00047         static ito::RetVal validateIntMeta(const ito::IntMeta *meta, int value);
00048         static ito::RetVal validateCharMeta(const ito::CharMeta *meta, char value);
00049         static ito::RetVal validateCharArrayMeta(const ito::ParamMeta *meta, const char* values, size_t len);
00050         static ito::RetVal validateIntArrayMeta(const ito::ParamMeta *meta, const int* values, size_t len);
00051         static ito::RetVal validateDoubleArrayMeta(const ito::ParamMeta *meta, const double* values, size_t len);
00052         static ito::RetVal validateHWMeta(const ito::HWMeta *meta, ito::AddInBase *value, bool mandatory = false);
00053         static ito::RetVal validateParam(const ito::Param &templateParam, const ito::ParamBase &param, bool strict = true, bool mandatory = false);
00054         static ito::RetVal validateAndCastParam(const ito::Param &templateParam, ito::ParamBase &param, bool strict = true, bool mandatory = false, bool roundToSteps = false);
00055         static ito::ParamBase convertParam(const ito::ParamBase &source, int destType, bool *ok = NULL);
00056         static ito::RetVal getParamFromMapByKey( QMap<QString,ito::Param> &paramMap, const QString &key, QMap<QString,ito::Param>::iterator &found, bool errorIfReadOnly);
00057         static ito::RetVal parseParamName(const QString &name, QString &paramName, bool &hasIndex, int &index, QString &additionalTag);
00058 
00059         static ito::RetVal getItemFromArray(const ito::Param &arrayParam, const int index, ito::Param &itemParam);
00060         static ito::Param getParam(const ito::Param &param, const bool hasIndex, const int index, ito::RetVal &ret);
00061 
00062         static ito::RetVal updateParameters(QMap<QString, ito::Param> &paramMap, const QVector<QSharedPointer<ito::ParamBase> > &values);
00063 
00064     private:
00065         static bool fitToDoubleStepSize(double min, double step, double val);
00066 
00067         ParamHelper(){};
00068         ~ParamHelper(){};
00069     };
00070 } //end namespace ito
00071 
00072 #endif
00073 
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends