MSDevice_Example.h

Go to the documentation of this file.

/****************************************************************************/
// A device which stands as an implementation example and which outputs movereminder calls
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
// Copyright (C) 2001-2013 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef MSDevice_Example_h
#define MSDevice_Example_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include "MSDevice.h"
#include <utils/common/SUMOTime.h>


// ===========================================================================
// class declarations
// ===========================================================================
class SUMOVehicle;


// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice_Example : public MSDevice {
public:
    static void insertOptions(OptionsCont& oc);


    static void buildVehicleDevices(SUMOVehicle& v, std::vector<MSDevice*>& into);



public:
    ~MSDevice_Example();




    bool notifyMove(SUMOVehicle& veh, SUMOReal oldPos,
                    SUMOReal newPos, SUMOReal newSpeed);


    bool notifyEnter(SUMOVehicle& veh, MSMoveReminder::Notification reason);


    bool notifyLeave(SUMOVehicle& veh, SUMOReal lastPos,
                     MSMoveReminder::Notification reason);



    void generateOutput() const;



private:
    MSDevice_Example(SUMOVehicle& holder, const std::string& id, SUMOReal customValue1,
                     SUMOReal customValue2, SUMOReal customValue3);



private:
    // private state members of the Example device

    SUMOReal myCustomValue1;

    SUMOReal myCustomValue2;

    SUMOReal myCustomValue3;



private:
    MSDevice_Example(const MSDevice_Example&);

    MSDevice_Example& operator=(const MSDevice_Example&);


};


#endif

/****************************************************************************/