Parameterised.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A super class for objects with additional parameters
/****************************************************************************/
#pragma once
#include <config.h>
#include <map>
#include <string>
#include <vector>
 
// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;
 
// ===========================================================================
// class definitions
// ===========================================================================
class Parameterised {
 
public:
    typedef std::map<std::string, std::string> Map;
 
    Parameterised();
 
    Parameterised(const Parameterised::Map& mapArg);
 
    virtual ~Parameterised();
 
    virtual void setParameter(const std::string& key, const std::string& value);
 
    void unsetParameter(const std::string& key);
 
    void updateParameters(const Parameterised::Map& mapArg);
 
    void mergeParameters(const Parameterised::Map& mapArg, const std::string separator = " ", bool uniqueValues = true);
 
    bool hasParameter(const std::string& key) const;
 
    virtual const std::string getParameter(const std::string& key, const std::string defaultValue = "") const;
 
    double getDouble(const std::string& key, const double defaultValue) const;
 
    std::vector<double> getDoubles(const std::string& key, std::vector<double> defaultValue = std::vector<double>()) const;
 
    void clearParameter();
 
    const Parameterised::Map& getParametersMap() const;
 
    std::string getParametersStr(const std::string kvsep = "=", const std::string sep = "|") const;
 
    void setParameters(const Parameterised& params);
 
    void setParametersStr(const std::string& paramsString, const std::string kvsep = "=", const std::string sep = "|");
 
    void writeParams(OutputDevice& device) const;
 
    static bool areParametersValid(const std::string& value, bool report = false, const std::string kvsep = "=", const std::string sep = "|");
 
    static bool areAttributesValid(const std::string& value, bool report = false, const std::string kvsep = "=", const std::string sep = "|");
 
private:
    static bool isParameterValid(const std::string& value, const std::string& kvsep, const std::string& sep);
 
    Parameterised::Map myMap;
};