options.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: options.h,v 1.26.14.1 2007/03/25 21:23:40 oliver Exp $
//

#ifndef BALL_DATATYPE_OPTIONS_H
#define BALL_DATATYPE_OPTIONS_H

#ifndef BALL_COMMON_H
# include <BALL/common.h>
#endif

#ifndef BALL_DATATYPE_STRING_H
# include <BALL/DATATYPE/string.h>
#endif

#ifndef BALL_DATATYPE_STRINGHASHMAP_H
# include <BALL/DATATYPE/stringHashMap.h>
#endif

#include <BALL/FORMAT/paramFile.h>

#ifndef BALL_MATHS_VECTOR3_H
# include <BALL/MATHS/vector3.h>
#endif

#ifndef BALL_CONCEPT_PERSISTENTOBJECT_H
# include <BALL/CONCEPT/persistentObject.h>
#endif

namespace BALL 
{
  class BALL_EXPORT Options
    : public StringHashMap<String> 
  {
    
    public:

    BALL_CREATE(Options)

    

    static const Size MAX_ENTRY_LENGTH;



    Options();

    Options(const Options& options);

    virtual ~Options();


    
    const Options& operator = (const Options& options);

    virtual void clear();



    bool isInteger(const String& key) const;

    bool isBool(const String& key) const;

    bool isReal(const String& key) const;

    bool isVector(const String& key) const;

    bool isSet(const String& key) const;




    void addParameterDescription(const String& key, String description, ParameterType type, list<String>* allowed_values = NULL);

    /* Return the description that was registered for the parameter identified by the given key */
    const ParameterDescription* getParameterDescription(const String& key) const;

    Options* createSubcategory(String name);

    Options* getSubcategory(String name);

    StringHashMap<Options*>::Iterator
    beginSubcategories();

    StringHashMap<Options*>::Iterator
    endSubcategories();

    void setName(const String& name);

    const String& getName() const;

    String get(const String& key) const;

    bool  getBool(const String& key) const;

    double getReal(const String& key) const;

    Vector3 getVector(const String& key) const;

    long getInteger(const String& key) const;

    void set(const String& key, const String& value);

    void setReal(const String& key, const double value);

    void setVector(const String& key, const Vector3& value);

    void setInteger(const String& key, const long value);

    void setBool(const String& key, const bool value);

    String setDefault(const String& key, const String& value);

    long setDefaultInteger(const String& key, const long value);

    double setDefaultReal(const String& key, const double value);

    bool setDefaultBool(const String& key, const bool value);

    bool readOptionFile(const String& filename);

    bool writeOptionFile(const String& filename) const;

    void write(PersistenceManager& pm) const;

    bool read(PersistenceManager& pm);

    bool operator == (const Options& option) const;

    bool operator != (const Options& option) const;



    
    virtual void dump (std::ostream& s = std::cout, Size depth = 0) const;


    protected:

    /*_ The option table's name */
    String    name_;
    StringHashMap<ParameterDescription> descriptions_;
    StringHashMap<Options*> subcategories_;
  };
} // namespace BALL

#endif // BALL_DATATYPE_OPTIONS_H