configurationhelper.h

/***************************************************************************
 *   Copyright (C) 2008-2011 by Tomassino Ferrauto, Gianluca Massera       *
 *   t_ferrauto@yahoo.it                                                   *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef CONFIGURATION_HELPER_H
#define CONFIGURATION_HELPER_H

#include "configurationparameters.h"
#include <QVector>

namespace farsa {

class FARSA_CONF_API ConfigurationHelper {
public:
    static int getInt( ConfigurationParameters& params, QString paramPath, int def = 0 );

    static unsigned int getUnsignedInt( ConfigurationParameters& params, QString paramPath, unsigned int def = 0 );
    
    static double getDouble( ConfigurationParameters& params, QString paramPath, double def = 0 );

    static bool getBool( ConfigurationParameters& params, QString paramPath, bool def = false );

    static QString getString( ConfigurationParameters& params, QString paramPath, QString def = QString() );
    
    static QStringList getStringList( ConfigurationParameters& params, QString paramPath, QString delimiter = QString(" ") );

    static QVector<double> getVector( ConfigurationParameters& params, QString paramPath, QString def = QString() );

    static QVector<int> getIntegerVector(ConfigurationParameters& params, QString paramPath, QString def = QString());

    static QVector<unsigned int> getUnsignedIntegerVector(ConfigurationParameters& params, QString paramPath, QString def = QString());
    
    static QVector<bool> getBoolVector(ConfigurationParameters& params, QString paramPath, QString def = QString());
    
    static bool hasGroup( ConfigurationParameters& params, QString group );

    static bool hasParameter( ConfigurationParameters& params, QString group, QString paramName );

    static void throwUserConfigError(QString paramName, QString paramValue, QString description);

    static void throwUserMissingResourceError(QString resourceName, QString description);
    
    static QStringList getDescribedParameterNames( QString type, QString prefix=QString() );

    static QStringList getDescribedSubgroupNames( QString type, QString prefix=QString() );

    static QString getParameterTypeName( QString type, QString paramName );
    
    static bool isRuntimeParameter( QString type, QString paramName );
    
    static bool parameterIsDouble( QString type, QString paramName );
    
    static QStringList getParameterEnumValues( QString type, QString paramName );

private:
    ConfigurationHelper() { /* nothing */ };
};

} // end namespace farsa

#endif