MSDevice_FCD.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2013-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
/****************************************************************************/
// A device which records floating car data
/****************************************************************************/
#pragma once
#include <config.h>
 
#include "MSVehicleDevice.h"
#include <microsim/MSVehicle.h>
#include <utils/common/SUMOTime.h>
#include <utils/shapes/SUMOPolygon.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
class SUMOVehicle;
class SUMOTrafficObject;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice_FCD : public MSVehicleDevice {
public:
    static void insertOptions(OptionsCont& oc);
 
    static void buildVehicleDevices(SUMOVehicle& v, std::vector<MSVehicleDevice*>& into);
 
public:
    ~MSDevice_FCD();
 
    bool notifyEnter(SUMOTrafficObject& /*veh*/, MSMoveReminder::Notification /*reason*/, const MSLane* /*enteredLane*/) {
        return false;
    }
 
    void saveState(OutputDevice& /* out */) const {
    }
 
    const std::string deviceName() const {
        return "fcd";
    }
 
    static inline SUMOTime getBegin() {
        return myBegin;
    }
 
    static inline SUMOTime getPeriod() {
        return myPeriod;
    }
 
    static inline bool useGeo() {
        return myUseGeo;
    }
 
    static inline double getMaxLeaderDistance() {
        return myMaxLeaderDistance;
    }
 
    static inline const std::vector<std::string>& getParamsToWrite() {
        return myParamsToWrite;
    }
 
    static inline double getRadius() {
        return myRadius;
    }
 
    static inline const std::set<const MSEdge*>& getEdgeFilter() {
        return myEdgeFilter;
    }
 
    static inline const SumoXMLAttrMask& getWrittenAttributes() {
        return myWrittenAttributes;
    }
 
    static void initOnce();
 
    static void cleanup();
 
    static bool shapeFilter(const SUMOTrafficObject* veh);
 
    inline static bool hasShapeFilter() {
        return myShapeFilterDesired;
    }
 
private:
    MSDevice_FCD(SUMOVehicle& holder, const std::string& id);
 
    static SUMOTime myBegin;
    static SUMOTime myPeriod;
    static bool myUseGeo;
    static double myMaxLeaderDistance;
    static std::vector<std::string> myParamsToWrite;
    static double myRadius;
 
    static std::set<const MSEdge*> myEdgeFilter;
    static bool myEdgeFilterInitialized;
 
    static std::vector<PositionVector> myShape4Filters;
    static bool myShapeFilterInitialized;
    static bool myShapeFilterDesired;
 
    static SumoXMLAttrMask myWrittenAttributes;
    static SumoXMLAttrMask getDefaultMask();
 
private:
    MSDevice_FCD(const MSDevice_FCD&);
 
    MSDevice_FCD& operator=(const MSDevice_FCD&);
 
    static void buildShapeFilter();
 
 
};