OptionsCont.h

Go to the documentation of this file.

/****************************************************************************/
// A storage for options (typed value containers)
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright 2001-2010 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 OptionsCont_h
#define OptionsCont_h
// ===========================================================================
// compiler pragmas
// ===========================================================================
#ifdef _MSC_VER
#pragma warning(disable: 4786)
#pragma warning(disable: 4503)
#endif


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

#include <map>
#include <string>
#include <vector>
#include <iostream>
#include "Option.h"


// ===========================================================================
// class definitions
// ===========================================================================
class OptionsCont {
public:
    static OptionsCont &getOptions() throw();


    OptionsCont() throw();


    ~OptionsCont() throw();




    void setApplicationName(const std::string &appName, const std::string &fullName) throw();


    void setApplicationDescription(const std::string &appDesc) throw();


    void addCallExample(const std::string &example) throw();


    void setAdditionalHelpMessage(const std::string &add) throw();


    void addOptionSubTopic(const std::string &topic) throw();


    void printHelp(std::ostream &os) throw();


    void writeConfiguration(std::ostream &os, bool filled,
                            bool complete, bool addComments) throw();


    void writeXMLHeader(std::ostream &os, const bool writeConfig=true) throw();





    void doRegister(const std::string &name, Option *v) throw(InvalidArgument);


    void doRegister(const std::string &name, char abbr, Option *v) throw(InvalidArgument);


    void addSynonyme(const std::string &name1, const std::string &name2) throw(InvalidArgument);


    void addDescription(const std::string &name, const std::string &subtopic,
                        const std::string &description) throw(InvalidArgument);





    bool exists(const std::string &name) const throw();


    bool isSet(const std::string &name) const throw(InvalidArgument);


    bool isDefault(const std::string &name) const throw(InvalidArgument);


    bool isBool(const std::string &name) const throw(InvalidArgument);


    bool isUsableFileList(const std::string &name) const throw(InvalidArgument);


    bool checkDependingSuboptions(const std::string &name, const std::string &prefix) const throw(InvalidArgument);


    void relocateFiles(const std::string &configuration) const throw();


    std::vector<std::string> getSynonymes(const std::string &name) const throw(InvalidArgument);


    bool isWriteable(const std::string &name) throw(InvalidArgument);





    std::string getString(const std::string &name) const throw(InvalidArgument);


    SUMOReal getFloat(const std::string &name) const throw(InvalidArgument);


    int getInt(const std::string &name) const throw(InvalidArgument);


    bool getBool(const std::string &name) const throw(InvalidArgument);


    const IntVector &getIntVector(const std::string &name) const throw(InvalidArgument);


    std::vector<std::string> getStringVector(const std::string &name) const throw(InvalidArgument);


    bool isInStringVector(const std::string &optionName,
                          const std::string &itemName) throw(InvalidArgument);





    bool set(const std::string &name, const std::string &value) throw(InvalidArgument);


    bool set(const std::string &name, bool value) throw(InvalidArgument);


    void resetWritable() throw();

    friend std::ostream& operator<<(std::ostream& os, const OptionsCont& oc);


    void clear() throw();


    bool processMetaOptions(bool missingOptions) throw(ProcessError);


private:
    Option *getSecure(const std::string &name) const throw(InvalidArgument);


    void reportDoubleSetting(const std::string &arg) const throw();


    std::string convertChar(char abbr) const throw();


    void splitLines(std::ostream &os, std::string what,
                    size_t offset, size_t nextOffset) throw();


private:
    static OptionsCont myOptions;

    typedef std::vector<Option*> ItemAddressContType;

    typedef std::map<std::string, Option*> KnownContType;

    ItemAddressContType myAddresses;

    KnownContType myValues;

    std::string myAppName, myFullName, myAppDescription, myAdditionalMessage;

    std::vector<std::string> myCallExamples, mySubTopics;

    std::map<std::string, std::vector<std::string> > mySubTopicEntries;

    mutable bool myHaveInformedAboutDeprecatedDivider;


private:
    class abbreviation_finder {
    public:
        explicit abbreviation_finder() { }

        bool operator()(const std::string &s) {
            return s.length()==1;
        }
    };


private:
    OptionsCont(const OptionsCont &s);

    OptionsCont &operator=(const OptionsCont &s);

};


#endif

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