MSMoveReminder.h

Go to the documentation of this file.

/****************************************************************************/
// Something on a lane to be noticed about vehicle movement
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2011 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This program 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 2 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef MSMoveReminder_h
#define MSMoveReminder_h


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

#include <map>
#include <utils/common/SUMOTime.h>
#include <utils/common/StdDefs.h>


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


// ===========================================================================
// class definitions
// ===========================================================================
class MSMoveReminder {
public:
    MSMoveReminder(MSLane* const lane=0, const bool doAdd=true) throw();


    virtual ~MSMoveReminder() throw() {}


    const MSLane* getLane() const throw() {
        return myLane;
    }


    enum Notification {
        NOTIFICATION_DEPARTED,
        NOTIFICATION_JUNCTION,
        NOTIFICATION_SEGMENT,
        NOTIFICATION_LANE_CHANGE,
        NOTIFICATION_TELEPORT,
        NOTIFICATION_PARKING,
        NOTIFICATION_ARRIVED, // arrived and everything after is treated as permanent deletion from the net
        NOTIFICATION_VAPORIZED,
        NOTIFICATION_TELEPORT_ARRIVED
    };



    virtual bool notifyEnter(SUMOVehicle& veh, Notification reason) throw() {
        UNUSED_PARAMETER(reason);
        UNUSED_PARAMETER(&veh);
        return true;
    }


    virtual bool notifyMove(SUMOVehicle& veh,
                            SUMOReal oldPos,
                            SUMOReal newPos,
                            SUMOReal newSpeed) throw() {
        UNUSED_PARAMETER(oldPos);
        UNUSED_PARAMETER(newPos);
        UNUSED_PARAMETER(newSpeed);
        UNUSED_PARAMETER(&veh);
        return true;
    }


    virtual bool notifyLeave(SUMOVehicle& veh, SUMOReal lastPos,
                             Notification reason) throw() {
        UNUSED_PARAMETER(reason);
        UNUSED_PARAMETER(lastPos);
        UNUSED_PARAMETER(&veh);
        return true;
    }


#ifdef HAVE_MESOSIM
    void updateDetector(SUMOVehicle& veh, SUMOReal entryPos, SUMOReal leavePos,
                        SUMOTime entryTime, SUMOTime currentTime, SUMOTime leaveTime) throw();
#endif



    virtual void notifyMoveInternal(SUMOVehicle& veh,
                                    SUMOReal timeOnLane,
                                    SUMOReal speed) throw() {
        UNUSED_PARAMETER(speed);
        UNUSED_PARAMETER(timeOnLane);
        UNUSED_PARAMETER(&veh);
    }


private:
    MSMoveReminder& operator=(const MSMoveReminder&); // just to avoid a compiler warning


protected:
    MSLane* const myLane;


#ifdef HAVE_MESOSIM
    std::map<SUMOVehicle*, std::pair<SUMOTime, SUMOReal> > myLastVehicleUpdateValues;
#endif

};


#endif

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