A vehicle as used by router. More...

#include <ROVehicle.h>

Public Member Functions
virtual ROVehicle *	copy (const std::string &id, unsigned int depTime, RORouteDef *newRoute) const
	Returns a copy of the vehicle using a new id, departure time and route. More...

SUMOTime	getDepartureTime () const
	Returns the time the vehicle starts at. More...

const std::string &	getID () const
	Returns the id of the vehicle. More...

SUMOReal	getMaxSpeed () const
	Returns the vehicle's maximum speed. More...

RORouteDef *	getRouteDefinition () const
	Returns the definition of the route the vehicle takes. More...

const SUMOVTypeParameter *	getType () const
	Returns the type of the vehicle. More...

SUMOVehicleClass	getVClass () const

	ROVehicle (const SUMOVehicleParameter &pars, RORouteDef route, const SUMOVTypeParameter type)
	Constructor. More...

void	saveAllAsXML (OutputDevice &os, OutputDevice const altos, OutputDevice const typeos, bool withExitTimes) const
	Saves the complete vehicle description. More...

virtual	~ROVehicle ()
	Destructor. More...

Protected Attributes
SUMOVehicleParameter	myParameter
	The vehicle's parameter. More...

RORouteDef *const	myRoute
	The route the vehicle takes. More...

const SUMOVTypeParameter *const	myType
	The type of the vehicle. More...

Private Member Functions
ROVehicle &	operator= (const ROVehicle &src)
	Invalidated assignment operator. More...

	ROVehicle (const ROVehicle &src)
	Invalidated copy constructor. More...

Detailed Description

A vehicle as used by router.

Definition at line 57 of file ROVehicle.h.

Constructor & Destructor Documentation

ROVehicle::ROVehicle	(	const SUMOVehicleParameter &	pars,
		RORouteDef *	route,
		const SUMOVTypeParameter *	type
	)

Constructor.

Parameters

[in]	pars	Parameter of this vehicle
[in]	route	The definition of the route the vehicle shall use
[in]	type	The type of the vehicle

Definition at line 54 of file ROVehicle.cpp.

Referenced by copy().

ROVehicle::~ROVehicle ( )

virtual

Destructor.

Definition at line 59 of file ROVehicle.cpp.

ROVehicle::ROVehicle ( const ROVehicle & src )

private

Invalidated copy constructor.

Member Function Documentation

ROVehicle * ROVehicle::copy	(	const std::string &	id,
		unsigned int	depTime,
		RORouteDef *	newRoute
	)		const

virtual

Returns a copy of the vehicle using a new id, departure time and route.

Parameters

[in]	id	the new id to use
[in]	depTime	The new vehicle's departure time
[in]	newRoute	The new vehicle's route

Returns: The new vehicle

Todo:: Is this used? What for if everything is replaced?

Definition at line 110 of file ROVehicle.cpp.

References SUMOVehicleParameter::depart, SUMOVehicleParameter::id, myParameter, myType, and ROVehicle().

SUMOTime ROVehicle::getDepartureTime ( ) const

inline

Returns the time the vehicle starts at.

Returns: The vehicle's depart time

Definition at line 108 of file ROVehicle.h.

References SUMOVehicleParameter::depart, and myParameter.

Referenced by ROLogitCalculator::calculateProbabilities(), RONet::computeRoute(), ROVehicleByDepartureComperator::operator()(), RONet::saveAndRemoveRoutesUntil(), and RORoute::writeXMLDefinition().

const std::string& ROVehicle::getID ( ) const

inline

Returns the id of the vehicle.

Returns: The id of the vehicle

Definition at line 99 of file ROVehicle.h.

References SUMOVehicleParameter::id, and myParameter.

Referenced by RORouteDef::addAlternative(), RONet::computeRoute(), ROVehicleCont::erase(), ROVehicleByDepartureComperator::operator()(), RORouteDef::preComputeCurrentRoute(), RORouteDef::repairCurrentRoute(), and RONet::saveAndRemoveRoutesUntil().

SUMOReal ROVehicle::getMaxSpeed ( ) const

Returns the vehicle's maximum speed.

Definition at line 104 of file ROVehicle.cpp.

References SUMOVTypeParameter::maxSpeed, and myType.

RORouteDef* ROVehicle::getRouteDefinition ( ) const

inline

Returns the definition of the route the vehicle takes.

Returns: The vehicle's route definition

Todo:: Why not return a reference?

Definition at line 79 of file ROVehicle.h.

References myRoute.

Referenced by RONet::computeRoute(), and RONet::saveAndRemoveRoutesUntil().

const SUMOVTypeParameter* ROVehicle::getType ( ) const

inline

Returns the type of the vehicle.

Returns: The vehicle's type

Todo:: Why not return a reference?

Definition at line 90 of file ROVehicle.h.

References myType.

Referenced by ROEdge::getCO2Effort(), ROEdge::getCOEffort(), ROEdge::getEffort(), ROEdge::getFuelEffort(), ROEdge::getHCEffort(), ROEdge::getMinimumTravelTime(), ROEdge::getNoiseEffort(), ROEdge::getNOxEffort(), ROEdge::getPMxEffort(), ROEdge::getTravelTime(), and getVClass().

SUMOVehicleClass ROVehicle::getVClass ( ) const

inline

Definition at line 117 of file ROVehicle.h.

References DEFAULT_VEH_CLASS, getType(), and SUMOVTypeParameter::vehicleClass.

Referenced by ROEdge::prohibits().

ROVehicle& ROVehicle::operator= ( const ROVehicle & src )

private

Invalidated assignment operator.

void ROVehicle::saveAllAsXML	(	OutputDevice &	os,
		OutputDevice *const	altos,
		OutputDevice *const	typeos,
		bool	withExitTimes
	)		const

Saves the complete vehicle description.

Saves the vehicle type if it was not saved before. Saves the vehicle route if it was not saved before. Saves the vehicle itself.

Parameters

[in]	os	The routes - output device to store the vehicle's description into
[in]	altos	The route alternatives - output device to store the vehicle's description into
[in]	typeos	The types - output device to store the vehicle types into
[in]	withExitTimes	whether exit times for the edges shall be written