GNEDemandElementDistribution.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-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 abstract class for demand elements distributions
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/xml/SUMOXMLDefinitions.h>
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class GNEUndoList;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEDemandElementDistribution {
 
    friend class GNEChange_Distribution;
    friend class GNERouteHandler;
 
public:
    GNEDemandElementDistribution(GNEDemandElement* demandElement);
 
    bool isDistributionEmpty() const;
 
    bool keyExists(const GNEDemandElement* key) const;
 
    bool isValueValid(const GNEDemandElement* key, const double value) const;
 
    const std::map<const GNEDemandElement*, double>& getDistributionKeyValues() const;
 
    std::map<std::string, GNEDemandElement*> getPossibleDistributionKeys(SumoXMLTag type) const;
 
    std::string getAttributeDistributionKeys() const;
 
    std::string getAttributeDistributionValues() const;
 
    double getAttributeDistributionValue(const GNEDemandElement* key);
 
    void addDistributionKey(const GNEDemandElement* key, const double value, GNEUndoList* undoList);
 
    void removeDistributionKey(const GNEDemandElement* key, GNEUndoList* undoList);
 
    void editDistributionValue(const GNEDemandElement* key, const double newValue, GNEUndoList* undoList);
 
private:
    GNEDemandElement* myDemandElement;
 
    std::map<const GNEDemandElement*, double> myDistributionValues;
 
    void addDistributionKey(const GNEDemandElement* key, const double value);
 
    void removeDistributionKey(const GNEDemandElement* key);
 
    void editDistributionValue(const GNEDemandElement* key, const double newValue);
 
    GNEDemandElementDistribution(const GNEDemandElementDistribution&) = delete;
 
    GNEDemandElementDistribution& operator=(const GNEDemandElementDistribution&) = delete;
};