MSDevice.h

Go to the documentation of this file.

/****************************************************************************/
// Abstract in-vehicle device
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright 2001-2010 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 MSDevice_h
#define MSDevice_h


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

#include <string>
#include <vector>
#include <microsim/MSVehicle.h>
#include <utils/common/UtilExceptions.h>


// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;


// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice {
public:
    MSDevice(MSVehicle &holder, const std::string &id) throw()
            : myHolder(holder), myID(id) {
    }


    virtual ~MSDevice() throw() { }


    MSVehicle &getHolder() const throw() {
        return myHolder;
    }


    const std::string &getID() throw() {
        return myID;
    }



    virtual void onTryEmit() { }


    virtual void enterLaneAtMove(MSLane* enteredLane, SUMOReal driven) { }


    virtual void enterLaneAtEmit(MSLane* enteredLane, const MSVehicle::State &state) { }


    virtual void enterLaneAtLaneChange(MSLane* enteredLane) { }


    virtual void leaveLaneAtMove(SUMOReal driven) { }


    virtual void leaveLane() { }


    virtual void onRemovalFromNet() { }
    // @}


    virtual void tripInfoOutput(OutputDevice &os) const throw(IOError) {
    }


protected:
    MSVehicle &myHolder;


private:
    std::string myID;


private:
    MSDevice(const MSDevice&);

    MSDevice& operator=(const MSDevice&);

};


#endif

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