CommonHandler.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 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
/****************************************************************************/
// Collection of functions used in handlers
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/xml/CommonXMLStructure.h>
#include <utils/xml/SUMOSAXHandler.h>
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class FileBucket;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class CommonHandler {
 
public:
    CommonHandler(FileBucket* fileBucket);
 
    virtual ~CommonHandler();
 
    void forceOverwriteElements();
 
    void forceRemainElements();
 
    void abortLoading();
 
    bool isErrorCreatingElement() const;
 
    bool isForceOverwriteElements() const;
 
    bool isForceRemainElements() const;
 
    bool isAbortLoading() const;
 
protected:
    FileBucket* myFileBucket = nullptr;
 
    CommonXMLStructure myCommonXMLStructure;
 
    bool myErrorCreatingElement = false;
 
    bool myOverwriteElements = false;
 
    bool myRemainElements = false;
 
    bool myAbortLoading = false;
 
    void parseParameters(const SUMOSAXAttributes& attrs);
 
    CommonXMLStructure::SumoBaseObject* getEmbeddedRoute(const CommonXMLStructure::SumoBaseObject* sumoBaseObject) const;
 
 
    void checkParsedParent(const SumoXMLTag currentTag, const std::vector<SumoXMLTag>& parentTags, bool& ok);
 
    bool checkListOfVehicleTypes(const SumoXMLTag tag, const std::string& id, const std::vector<std::string>& vTypeIDs);
 
    bool checkWithinDistribution(CommonXMLStructure::SumoBaseObject* obj);
 
    bool checkVehicleParents(CommonXMLStructure::SumoBaseObject* obj);
 
    bool checkPersonPlanParents(CommonXMLStructure::SumoBaseObject* obj);
 
    bool checkContainerPlanParents(CommonXMLStructure::SumoBaseObject* obj);
 
    bool checkStopParents(CommonXMLStructure::SumoBaseObject* obj);
 
    bool checkNegative(const SumoXMLTag tag, const std::string& id, const SumoXMLAttr attribute, const int value, const bool canBeZero);
 
    bool checkNegative(const SumoXMLTag tag, const std::string& id, const SumoXMLAttr attribute, const double value, const bool canBeZero);
 
    bool checkNegative(const SumoXMLTag tag, const std::string& id, const SumoXMLAttr attribute, const SUMOTime value, const bool canBeZero);
 
    bool checkFileName(const SumoXMLTag tag, const std::string& id, const SumoXMLAttr attribute, const std::string& value);
 
    bool checkValidAdditionalID(const SumoXMLTag tag, const std::string& value);
 
    bool checkValidDetectorID(const SumoXMLTag tag, const std::string& value);
 
    bool checkValidDemandElementID(const SumoXMLTag tag, const std::string& value);
 
 
    void writeWarningOverwriting(const SumoXMLTag tag, const std::string& id);
 
    bool writeWarningDuplicated(const SumoXMLTag tag, const std::string& id, const SumoXMLTag checkedTag);
 
    bool writeError(const std::string& error);
 
    bool writeErrorInvalidPosition(const SumoXMLTag tag, const std::string& id);
 
    bool writeErrorInvalidLanes(const SumoXMLTag tag, const std::string& id);
 
    bool writeErrorInvalidParent(const SumoXMLTag tag, const std::string& id, const std::vector<SumoXMLTag> parentTags, const std::string& parentID);
 
    bool writeErrorInvalidParent(const SumoXMLTag tag, const std::vector<SumoXMLTag> parentTags, const std::string& parentID);
 
    bool writeErrorInvalidParent(const SumoXMLTag tag, const std::vector<SumoXMLTag> parentTags);
 
private:
    std::string parseParentTags(std::vector<SumoXMLTag> parentTags) const;
 
    CommonHandler() = delete;
 
    CommonHandler(const CommonHandler& s) = delete;
 
    CommonHandler& operator=(const CommonHandler& s) = delete;
};