Option.h

Go to the documentation of this file.

/****************************************************************************/
// Classes representing a single program option (with different types)
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2011 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   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.
//
/****************************************************************************/
#ifndef Option_h
#define Option_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <string>
#include <vector>
#include <exception>
#include <utils/common/UtilExceptions.h>


// ===========================================================================
// class definitions
// ===========================================================================
typedef std::vector<int> IntVector;


/* -------------------------------------------------------------------------
 * Option
 * ----------------------------------------------------------------------- */
class Option {
public:
    virtual ~Option();


    bool isSet() const;


    virtual SUMOReal getFloat() const;


    virtual int getInt() const;


    virtual std::string getString() const;


    virtual bool getBool() const;


    virtual const IntVector& getIntVector() const;


    virtual bool set(const std::string& v) = 0;


    virtual std::string getValueString() const = 0;


    virtual bool isBool() const;


    virtual bool isDefault() const;


    virtual bool isFileName() const;


    bool isWriteable() const;


    void resetWritable();


    const std::string& getDescription() const;


    void setDescription(const std::string& desc);


    virtual const std::string& getTypeName() const;


protected:
    bool markSet();


protected:
    Option(bool set=false);


    Option(const Option& s);


    virtual Option& operator=(const Option& s);


protected:
    std::string myTypeName;


private:
    bool myAmSet;

    bool myHaveTheDefaultValue;

    bool myAmWritable;

    std::string myDescription;

};


/* -------------------------------------------------------------------------
 * Option_Integer
 * ----------------------------------------------------------------------- */
class Option_Integer : public Option {
public:
    Option_Integer();


    Option_Integer(int value);


    Option_Integer(const Option_Integer& s);


    ~Option_Integer();


    Option_Integer& operator=(const Option_Integer& s);


    int getInt() const;


    bool set(const std::string& v);


    std::string getValueString() const;


private:
    int      myValue;

};


/* -------------------------------------------------------------------------
 * Option_String
 * ----------------------------------------------------------------------- */
class Option_String : public Option {
public:
    Option_String();


    Option_String(const std::string& value, std::string typeName="STR");


    Option_String(const Option_String& s);


    virtual ~Option_String();


    Option_String& operator=(const Option_String& s);


    std::string getString() const;


    bool set(const std::string& v);


    std::string getValueString() const;


protected:
    std::string      myValue;

};


/* -------------------------------------------------------------------------
 * Option_Float
 * ----------------------------------------------------------------------- */
class Option_Float : public Option {
public:
    Option_Float();


    Option_Float(SUMOReal value);


    Option_Float(const Option_Float& s);


    ~Option_Float();


    Option_Float& operator=(const Option_Float& s);


    SUMOReal getFloat() const;


    bool set(const std::string& v);


    std::string getValueString() const;


private:
    SUMOReal       myValue;

};


/* -------------------------------------------------------------------------
 * Option_Bool
 * ----------------------------------------------------------------------- */
class Option_Bool : public Option {
public:
    Option_Bool();


    Option_Bool(bool value);


    Option_Bool(const Option_Bool& s);


    ~Option_Bool();


    Option_Bool& operator=(const Option_Bool& s);


    bool getBool() const;

    bool set(const std::string& v);


    std::string getValueString() const;


    bool isBool() const;


private:
    bool        myValue;

};


/* -------------------------------------------------------------------------
 * Option_FileName
 * ----------------------------------------------------------------------- */
class Option_FileName : public Option_String {
public:
    Option_FileName();


    Option_FileName(const std::string& value);


    Option_FileName(const Option_String& s);


    virtual ~Option_FileName();

    Option_FileName& operator=(const Option_FileName& s);


    bool isFileName() const;

};


/* -------------------------------------------------------------------------
 * Option_IntVector
 * ----------------------------------------------------------------------- */
class Option_IntVector : public Option {
public:
    Option_IntVector();


    Option_IntVector(const IntVector& value);


    Option_IntVector(const Option_IntVector& s);


    virtual ~Option_IntVector();


    Option_IntVector& operator=(const Option_IntVector& s);


    const IntVector& getIntVector() const;


    bool set(const std::string& v);


    std::string getValueString() const;


private:
    IntVector myValue;
};


#endif

/****************************************************************************/