hydrolibs/hydroutil/properties.h

/*
Orca Project: Components for robotics 
             http://orca-robotics.sf.net/
Copyright (c) 2004-2007 Alex Brooks, Alexei Makarenko, Tobias Kaupp
 *
This copy of Orca is licensed to you under the terms described in the
ORCA_LICENSE file included in this distribution.
 *
 */

#ifndef HYDROUTIL_PROPERTIES_H
#define HYDROUTIL_PROPERTIES_H

#include <string>
#include <map>
#include <vector>

namespace hydroutil
{

class Properties
{
public:

    struct Config
    {
        Config( bool warnDefaultProp=false ) :
            warnDefaultProperty(warnDefaultProp) {};

        bool warnDefaultProperty;
    };

    Properties( const Config& config=Config() );
    
    Properties( const std::map<std::string,std::string>& props, 
                const std::string& removePrefix="",
                const Config& config=Config(),
                const std::string &previouslyStrippedPrefix="" );

    bool isDefined( const ::std::string& key );
    
    void ensureDefined( const std::string& key );

    int getProperty( const ::std::string& key, std::string &value ) const;
    
    std::string getPropertyWithDefault( const ::std::string& key, const std::string &defaultValue ) const;
    
    int getPropertyAsDouble( const ::std::string& key, double &value ) const;
    
    double getPropertyAsDoubleWithDefault( const ::std::string& key, const double defaultValue ) const;

    int getPropertyAsDoubleVector( const ::std::string& key, std::vector<double> &value ) const;
    
    std::vector<double> getPropertyAsDoubleVectorWithDefault( const ::std::string& key, const std::vector<double> &defaultValue ) const;

    int getPropertyAsInt( const ::std::string& key, int &value ) const;
    
    int getPropertyAsIntWithDefault( const ::std::string& key, const int defaultValue ) const;

    int getPropertyAsIntVector( const ::std::string& key, std::vector<int> &value ) const;

    std::vector<int> getPropertyAsIntVectorWithDefault( const ::std::string& key, const std::vector<int> &defaultValue ) const;
    
    void setProperty( const ::std::string& key, const ::std::string& value );
    
    Properties propertiesWithStrippedPrefix( const std::string &prefixToStrip ) const;

    size_t size() const { return props_.size(); }; 

    std::string toString() const;

    std::string missingPropertyWarning( const std::string& key, bool fatal=false );

    const Config &config() const { return config_; }

private:

    // Track the stripped prefix so we can report the _entire_ property string when defaults are used
    std::string strippedPrefix_;

    std::map<std::string,std::string> props_;
    Config config_;
};

} // end namespace

#endif