MSDevice_FCDReplay.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2013-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 device which replays recorded floating car data
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/common/Command.h>
#include <utils/common/MapMatcher.h>
#include <utils/xml/SUMOSAXHandler.h>
#include "MSVehicleDevice.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class SUMOSAXReader;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice_FCDReplay : public MSVehicleDevice {
public:
    static void insertOptions(OptionsCont& oc);
 
 
    static void buildVehicleDevices(SUMOVehicle& v, std::vector<MSVehicleDevice*>& into);
 
    static void init();
    static SUMOTime parseNext(SUMOTime t);
 
public:
    ~MSDevice_FCDReplay();
 
    void move(SUMOTime currentTime);
 
    const std::string deviceName() const override {
        return "fcd-replay";
    }
 
    struct TrajectoryEntry {
        SUMOTime time;
        Position pos;
        std::string edgeOrLane;
        double lanePos;
        double speed;
        double angle;
    };
 
    typedef std::vector<TrajectoryEntry> Trajectory;
 
    void setTrajectory(const Trajectory* const t) {
        myTrajectory = t;
        myTrajectoryIndex = 1;
    }
 
private:
    MSDevice_FCDReplay(SUMOVehicle& holder, const std::string& id);
 
    class MoveVehicles : public Command {
    public:
        SUMOTime execute(SUMOTime currentTime) override;
    private:
        MoveVehicles& operator=(const MoveVehicles&) = delete;
    };
 
    class FCDHandler : public SUMOSAXHandler, public MapMatcher<MSEdge, MSLane, MSJunction> {
    public:
        FCDHandler(const std::string& file);
        SUMOTime getTime() const {
            return myTime;
        }
        void updateTrafficObjects(const SUMOTime intervalStart);
 
        const std::map<std::string, Trajectory>& getTrajectories() {
            return myTrajectories;
        }
 
    protected:
 
 
        void myStartElement(int element, const SUMOSAXAttributes& attrs) override;
 
        void initLaneTree(NamedRTree* tree) override;
 
        MSEdge* retrieveEdge(const std::string& id) override;
 
    private:
        struct StageStart {
            std::string vehicle;
            int trajectoryOffset;
            int routeOffset;
        };
 
        MSTransportable::MSTransportablePlan* makePlan(const SUMOVehicleParameter& params, const ConstMSEdgeVector& route,
                const std::vector<StageStart>& stages, const Trajectory& t);
        ConstMSEdgeVector checkRoute(const ConstMSEdgeVector& edges, const SUMOVehicle* const vehicle);
 
        SUMOTime myTime = 0;
        std::map<std::string, Trajectory> myTrajectories;
        std::map<std::string, std::tuple<SUMOTime, std::string, bool, ConstMSEdgeVector, std::vector<StageStart> > > myRoutes;
        std::map<const Position, std::string> myPositions;
    };
 
private:
    static FCDHandler* myHandler;
    static SUMOSAXReader* myParser;
    const Trajectory* myTrajectory = nullptr;
    int myTrajectoryIndex = 0;
 
private:
    MSDevice_FCDReplay(const MSDevice_FCDReplay&) = delete;
 
    MSDevice_FCDReplay& operator=(const MSDevice_FCDReplay&) = delete;
 
};