MSRouteProbe::EntryReminder Class Reference

#include <MSRouteProbe.h>

Inheritance diagram for MSRouteProbe::EntryReminder:

Detailed Description

A place on the road net (at a certain lane and position on it) where the E3-area begins.

Definition at line 71 of file MSRouteProbe.h.


Public Member Functions
	EntryReminder (MSLane *const lane, MSRouteProbe &collector) throw ()
	Constructor.
const MSLane *const	getLane () const throw ()
	Returns the lane the reminder works on.
Interface methods, to be derived by subclasses
virtual bool	isStillActive (MSVehicle &veh, SUMOReal oldPos, SUMOReal newPos, SUMOReal newSpeed) throw ()
	Checks whether the reminder still has to be notified about the vehicle moves.
virtual void	notifyLeave (MSVehicle &veh, bool isArrival, bool isLaneChange) throw ()
	Called if the vehicle leaves the reminder's lane.
Methods inherited from MSMoveReminder
bool	notifyEnter (MSVehicle &veh, bool isEmit, bool isLaneChange) throw ()
	Returns whether the vehicle shall be aware of this entry.
Protected Attributes
MSLane *const	myLane
	Lane on which the reminder works.
Private Member Functions
	EntryReminder (const EntryReminder &)
	Invalidated copy constructor.
EntryReminder &	operator= (const EntryReminder &)
	Invalidated assignment operator.
Private Attributes
MSRouteProbe &	myCollector
	The parent collector.

Constructor & Destructor Documentation

MSRouteProbe::EntryReminder::EntryReminder	(	MSLane *const	lane,
		MSRouteProbe &	collector
	)			throw ()

Constructor.

Parameters:

`[in]`	lane	The lane the entry belongs to
`[in]`	collector	The detector the entry belongs to

Definition at line 52 of file MSRouteProbe.cpp.

00053         : MSMoveReminder(lane), myCollector(collector) {}

MSRouteProbe::EntryReminder::EntryReminder ( const EntryReminder & ) [private]

Invalidated copy constructor.

Member Function Documentation

const MSLane* const MSMoveReminder::getLane ( ) const throw () [inline, inherited]

Returns the lane the reminder works on.

Returns:: The lane the reminder works on.

Definition at line 80 of file MSMoveReminder.h.

References MSMoveReminder::myLane.

Referenced by GUIInductLoop::MyWrapper::getParameterWindow(), GUI_E2_ZS_Collector::MyWrapper::getParameterWindow(), GUINet::initDetectors(), MSMeanData_Net::MSLaneMeanDataValues::isStillActive(), MSMeanData_HBEFA::MSLaneMeanDataValues::isStillActive(), MSMeanData_Harmonoise::MSLaneMeanDataValues::isStillActive(), MSE2Collector::update(), and MSMeanData::writeEdge().

00080                                                 {
00081         return myLane;
00082     }

virtual bool MSMoveReminder::isStillActive	(	MSVehicle &	veh,
		SUMOReal	oldPos,
		SUMOReal	newPos,
		SUMOReal	newSpeed
	)			throw () `[inline, virtual, inherited]`

Checks whether the reminder still has to be notified about the vehicle moves.

Indicator if the reminders is still active for the passed vehicle/parameters. If false, the vehicle will erase this reminder from it's reminder-container.

Parameters:

	veh	Vehicle that asks this reminder.
	oldPos	Position before move.
	newPos	Position after move with newSpeed.
	newSpeed	Moving speed.

Returns:: True if vehicle hasn't passed the reminder completely.

Reimplemented in MSE2Collector, MSE3Collector::MSE3EntryReminder, MSE3Collector::MSE3LeaveReminder, MSInductLoop, MSMeanData::MeanDataValueTracker, MSMeanData_Harmonoise::MSLaneMeanDataValues, MSMeanData_HBEFA::MSLaneMeanDataValues, MSMeanData_Net::MSLaneMeanDataValues, and MSTriggeredRerouter::Setter.

Definition at line 101 of file MSMoveReminder.h.

00104                                                           {
00105         return true;
00106     }

bool MSRouteProbe::EntryReminder::notifyEnter	(	MSVehicle &	veh,
		bool	isEmit,
		bool	isLaneChange
	)			throw () `[virtual]`

Returns whether the vehicle shall be aware of this entry.

Returns true if the vehicle is in front of the entry, so that it may enter it in later steps.

Parameters:

`[in]`	veh	The vehicle that enters the lane
`[in]`	isEmit	whether the vehicle was just emitted into the net
`[in]`	isLaneChange	whether the vehicle changed to the lane

See also:: MSMoveReminder::notifyEnter

Returns:: False, if vehicle passed the entry, else true.

Reimplemented from MSMoveReminder.

Definition at line 57 of file MSRouteProbe.cpp.

00057                                                                                              {
00058     myCollector.addRoute(veh.getRoute());
00059     return false;
00060 }

virtual void MSMoveReminder::notifyLeave	(	MSVehicle &	veh,
		bool	isArrival,
		bool	isLaneChange
	)			throw () `[inline, virtual, inherited]`

Called if the vehicle leaves the reminder's lane.

Informs if vehicle leaves reminder lane (due to lane change, removal from the network, or leaving to the next lane). The default is to do nothing.

Parameters:

`[in]`	veh	The leaving vehicle.
`[in]`	isArrival	whether the vehicle arrived at its destination
`[in]`	isLaneChange	whether the vehicle changed from the lane