MSDevice_Example.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 stands as an implementation example and which outputs movereminder calls
/****************************************************************************/
#pragma once
#include <config.h>
 
#include "MSVehicleDevice.h"
#include <utils/common/SUMOTime.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class SUMOTrafficObject;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice_Example : public MSVehicleDevice {
public:
    static void insertOptions(OptionsCont& oc);
 
 
    static void buildVehicleDevices(SUMOVehicle& v, std::vector<MSVehicleDevice*>& into);
 
    static void cleanup();
 
public:
    ~MSDevice_Example();
 
 
 
 
    bool notifyMove(SUMOTrafficObject& veh, double oldPos,
                    double newPos, double newSpeed);
 
 
    bool notifyEnter(SUMOTrafficObject& veh, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
 
    bool notifyLeave(SUMOTrafficObject& veh, double lastPos,
                     MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
 
    const std::string deviceName() const {
        return "example";
    }
 
    std::string getParameter(const std::string& key) const;
 
    void setParameter(const std::string& key, const std::string& value);
 
    void generateOutput(OutputDevice* tripinfoOut) const;
 
 
 
private:
    MSDevice_Example(SUMOVehicle& holder, const std::string& id, double customValue1,
                     double customValue2, double customValue3);
 
 
 
private:
    // private state members of the Example device
 
    double myCustomValue1;
 
    double myCustomValue2;
 
    double myCustomValue3;
 
 
 
private:
    MSDevice_Example(const MSDevice_Example&);
 
    MSDevice_Example& operator=(const MSDevice_Example&);
 
 
};