Parameterised.h

Go to the documentation of this file.

/****************************************************************************/
// A super class for objects with additional parameters
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2002-2017 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO 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 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef Parameterised_h
#define Parameterised_h


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

#include <map>
#include <string>

// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;

// ===========================================================================
// class definitions
// ===========================================================================
class Parameterised {
public:
    Parameterised();


    Parameterised(const std::map<std::string, std::string>& mapArg);


    ~Parameterised();



    void addParameter(const std::string& key, const std::string& value);


    void addParameter(const std::map<std::string, std::string>& mapArg);


    void addParameter(const Parameterised& p);


    bool knowsParameter(const std::string& key) const;


    const std::string& getParameter(const std::string& key, const std::string& defaultValue) const;


    void clearParameter();


    const std::map<std::string, std::string>& getMap() const {
        return myMap;
    }

    void writeParams(OutputDevice& out) const;


private:
    std::map<std::string, std::string> myMap;

};


#endif

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