ROCCHMetrics.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2026 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
/****************************************************************************/
// The CCH metric store of the router applications (duarouter, marouter):
// thin static trampolines (CCHRouter's MetricProvider, PeriodEnd and reset
// hooks are plain function pointers) over the shared CCHMetricFamily in
// STATIC mode -- lazy per-(vehicle type, weight period) customization,
// filled with the querying vehicle, with the restriction-params edges of a
// type masked to inf_weight by a post-fill patch. marouter has no weight
// periods but changes the travel times after every assignment iteration and
// resets its router there: the reset flags every metric for
// re-customization on the next query. See utils/router/CCHMetricFamily.h
// for the semantics.
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/common/SUMOTime.h>
#include <utils/common/SUMOVehicleClass.h>
#include <utils/router/CCHGraph.h>
#include <utils/router/CCHMetricFamily.h>
 
class ROEdge;
class ROVehicle;
class SUMOVTypeParameter;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
using ROCCHGraph = CCHGraph<ROEdge, ROVehicle>;
using ROCCHMetricFamily = CCHMetricFamily<ROEdge, ROVehicle, SUMOVTypeParameter>;
 
 
class ROCCHMetrics {
public:
    static void init(const ROCCHGraph* graph, ROCCHGraph::EffortOperation effort,
                     SUMOTime begin, SUMOTime weightPeriod);
 
    static const RoutingKit::CustomizableContractionHierarchyMetric* get(
        SUMOVehicleClass vClass, SUMOTime time, const ROVehicle* veh);
 
    static SUMOTime periodEnd(SUMOTime time);
 
    static void reset(const ROVehicle* veh);
 
private:
    static void patchRestrictions(const ROCCHGraph* graph, const ROVehicle* veh,
                                  std::vector<unsigned>& weights);
 
    static ROCCHMetricFamily* myFamily;
};