A vehicle as used by router. More...

#include <ROVehicle.h>

Inheritance diagram for ROVehicle:

Collaboration diagram for ROVehicle:

Public Member Functions
void	computeRoute (const RORouterProvider &provider, const bool removeLoops, MsgHandler *errorHandler)

SUMOReal	getChosenSpeedFactor () const
	Returns an upper bound for the speed factor of this vehicle. More...

SUMOTime	getDepart () const
	Returns the time the vehicle starts at, -1 for triggered vehicles. More...

const ROEdge *	getDepartEdge () const
	Returns the first edge the vehicle takes. More...

SUMOTime	getDepartureTime () const
	Returns the time the vehicle starts at, 0 for triggered vehicles. More...

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

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

const SUMOVehicleParameter &	getParameter () const
	Returns the definition of the vehicle parameter. More...

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

bool	getRoutingSuccess () const

const ConstROEdgeVector &	getStopEdges () const

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

SUMOVehicleClass	getVClass () const

	ROVehicle (const SUMOVehicleParameter &pars, RORouteDef route, const SUMOVTypeParameter type, const RONet net, MsgHandler errorHandler=0)
	Constructor. More...

void	saveAsXML (OutputDevice &os, OutputDevice *const typeos, bool asAlternatives, OptionsCont &options) const
	Saves the complete vehicle description. More...

void	write (OutputDevice &os, OutputDevice const altos, OutputDevice const typeos, OptionsCont &options) const
	Saves the routable including the vehicle type (if it was not saved before). More...

virtual	~ROVehicle ()
	Destructor. More...

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

bool	myRoutingSuccess
	Whether the last routing was successful. More...

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

Private Member Functions
void	addStop (const SUMOVehicleParameter::Stop &stopPar, const RONet net, MsgHandler errorHandler)
	Adds a stop to this vehicle. More...

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

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

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

ConstROEdgeVector	myStopEdges
	The edges where the vehicle stops. More...

Detailed Description

A vehicle as used by router.

Definition at line 60 of file ROVehicle.h.

Constructor & Destructor Documentation

§ ROVehicle() [1/2]

ROVehicle::ROVehicle	(	const SUMOVehicleParameter &	pars,
		RORouteDef *	route,
		const SUMOVTypeParameter *	type,
		const RONet *	net,
		MsgHandler *	errorHandler = `0`
	)

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 56 of file ROVehicle.cpp.

References addStop(), RONet::getEdge(), RORouteDef::getFirstRoute(), RORoute::getStops(), RORoutable::myParameter, myStopEdges, SUMOVehicleParameter::stops, and SUMOVehicleParameter::via.

§ ~ROVehicle()

ROVehicle::~ROVehicle ( )

virtual

Destructor.

Definition at line 125 of file ROVehicle.cpp.

§ ROVehicle() [2/2]

ROVehicle::ROVehicle ( const ROVehicle & src )

private

Invalidated copy constructor.

Member Function Documentation

§ addStop()

void ROVehicle::addStop	(	const SUMOVehicleParameter::Stop &	stopPar,
		const RONet *	net,
		MsgHandler *	errorHandler
	)

private

Adds a stop to this vehicle.

Parameters

[in]	stopPar	the stop paramters
[in]	net	pointer to the network, used for edge retrieval

Definition at line 82 of file ROVehicle.cpp.

References SUMOVehicleParameter::Stop::endPos, RONet::getEdgeForLaneID(), RORoute::getEdgeVector(), RORouteDef::getFirstRoute(), Named::getID(), RORoutable::getID(), SUMOVehicleParameter::Stop::index, MsgHandler::inform(), SUMOVehicleParameter::Stop::lane, RORoutable::myParameter, myRoute, myStopEdges, ROEdge::prohibits(), STOP_INDEX_END, STOP_INDEX_FIT, and SUMOVehicleParameter::stops.

Referenced by getChosenSpeedFactor(), and ROVehicle().

§ computeRoute()

void ROVehicle::computeRoute	(	const RORouterProvider &	provider,
		const bool	removeLoops,
		MsgHandler *	errorHandler
	)

virtual

Implements RORoutable.

Definition at line 135 of file ROVehicle.cpp.

References RORouteDef::addAlternative(), RORouteDef::buildCurrentRoute(), getDepartureTime(), RORoutable::getID(), getRouteDefinition(), RouterProvider< E, L, N, V >::getVehicleRouter(), MsgHandler::inform(), RORoutable::myRoutingSuccess, RORoute::recheckForLoops(), and RORoute::size().

Referenced by getParameter().

§ getChosenSpeedFactor()

SUMOReal ROVehicle::getChosenSpeedFactor ( ) const

inline

Returns an upper bound for the speed factor of this vehicle.

Returns: the maximum speed factor

Definition at line 124 of file ROVehicle.h.

References addStop(), RORoutable::getType(), saveAsXML(), SUMOVTypeParameter::speedFactor, and SUMOReal.

Referenced by ROEdge::getMinimumTravelTime().

§ getDepart()

SUMOTime RORoutable::getDepart ( ) const

inlineinherited

Returns the time the vehicle starts at, -1 for triggered vehicles.

Returns: The vehicle's depart time

Definition at line 101 of file RORoutable.h.

References SUMOVehicleParameter::depart, and RORoutable::myParameter.

Referenced by RONet::addPerson(), RONet::addVehicle(), and ROVehicleByDepartureComperator::operator()().

§ getDepartEdge()

const ROEdge * ROVehicle::getDepartEdge ( ) const

virtual

Returns the first edge the vehicle takes.

Returns: The vehicle's departure edge

Implements RORoutable.

Definition at line 129 of file ROVehicle.cpp.

References RORoute::getFirst(), RORouteDef::getFirstRoute(), and myRoute.

Referenced by getParameter().

§ getDepartureTime()

SUMOTime ROVehicle::getDepartureTime ( ) const

inline

Returns the time the vehicle starts at, 0 for triggered vehicles.

Returns: The vehicle's depart time

Definition at line 111 of file ROVehicle.h.

References SUMOVehicleParameter::depart, MAX2(), and RORoutable::myParameter.

Referenced by RORouteDef::addAlternative(), computeRoute(), and RORoute::writeXMLDefinition().

§ getID()

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

inlineinherited

Returns the id of the vehicle.

Returns: The id of the vehicle

Definition at line 92 of file RORoutable.h.

References SUMOVehicleParameter::id, and RORoutable::myParameter.

Referenced by RORouteDef::addAlternative(), RONet::addPerson(), addStop(), ROPerson::addTrip(), ROPerson::computeIntermodal(), computeRoute(), RONet::createBulkRouteRequests(), ROVehicleByDepartureComperator::operator()(), RORouteDef::preComputeCurrentRoute(), and RORouteDef::repairCurrentRoute().

§ getMaxSpeed()

SUMOReal RORoutable::getMaxSpeed ( ) const

inlineinherited

Returns the vehicle's maximum speed.

Definition at line 112 of file RORoutable.h.

References RORoutable::computeRoute(), RORoutable::getDepartEdge(), SUMOVTypeParameter::maxSpeed, and RORoutable::myType.

Referenced by RONet::createBulkRouteRequests().

§ getParameter()

const SUMOVehicleParameter& ROVehicle::getParameter ( ) const

inline

Returns the definition of the vehicle parameter.

Returns: The vehicle's parameter

Definition at line 92 of file ROVehicle.h.

References computeRoute(), getDepartEdge(), and RORoutable::myParameter.

Referenced by RONet::adaptIntermodalRouter().

§ getRouteDefinition()

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 83 of file ROVehicle.h.

References myRoute.

Referenced by ROPerson::computeIntermodal(), computeRoute(), RONet::saveAndRemoveRoutesUntil(), and RONet::~RONet().

§ getRoutingSuccess()

bool RORoutable::getRoutingSuccess ( ) const

inlineinherited

Definition at line 144 of file RORoutable.h.

References RORoutable::myRoutingSuccess, and RORoutable::saveAsXML().

Referenced by RONet::saveAndRemoveRoutesUntil().

§ getStopEdges()

const ConstROEdgeVector& ROVehicle::getStopEdges ( ) const

inline

Definition at line 116 of file ROVehicle.h.

References myStopEdges.

Referenced by RORouteDef::repairCurrentRoute().

§ getType()

const SUMOVTypeParameter* RORoutable::getType ( ) const

inlineinherited

Returns the type of the vehicle.

Returns: The vehicle's type

Todo:: Why not return a reference?

Definition at line 83 of file RORoutable.h.

References RORoutable::myType.

Referenced by getChosenSpeedFactor(), ROEdge::getEffort(), ROEdge::getEmissionEffort(), ROEdge::getMinimumTravelTime(), ROEdge::getNoiseEffort(), ROEdge::getTravelTime(), and RORoutable::getVClass().

§ getVClass()

SUMOVehicleClass RORoutable::getVClass ( ) const

inlineinherited

Definition at line 106 of file RORoutable.h.

References RORoutable::getType(), SVC_IGNORING, and SUMOVTypeParameter::vehicleClass.

Referenced by RONet::createBulkRouteRequests(), ROEdge::isConnectedTo(), and ROEdge::prohibits().

§ operator=()

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

private

Invalidated assignment operator.

§ saveAsXML()

void ROVehicle::saveAsXML	(	OutputDevice &	os,
		OutputDevice *const	typeos,
		bool	asAlternatives,
		OptionsCont &	options
	)		const

virtual

Saves the complete vehicle description.

Saves the vehicle itself including the route and stops.

Parameters

[in]	os	The routes or alternatives output device to store the vehicle's description into
[in]	typeos	The types - output device to store types into
[in]	asAlternatives	Whether the route shall be saved as route alternatives
[in]	options	to find out about defaults and whether exit times for the edges shall be written

Exceptions

IOError If something fails (not yet implemented)

Implements RORoutable.

Definition at line 171 of file ROVehicle.cpp.

References OutputDevice::closeTag(), OptionsCont::getBool(), Parameterised::getMap(), RORoutable::myParameter, myRoute, RORoutable::myType, OutputDevice::openTag(), SUMOVTypeParameter::saved, SUMOVehicleParameter::stops, SUMO_ATTR_KEY, SUMO_ATTR_VALUE, SUMO_TAG_PARAM, SUMOVTypeParameter::write(), SUMOVehicleParameter::write(), OutputDevice::writeAttr(), and RORouteDef::writeXMLDefinition().

Referenced by getChosenSpeedFactor().

§ write()

void RORoutable::write	(	OutputDevice &	os,
		OutputDevice *const	altos,
		OutputDevice *const	typeos,
		OptionsCont &	options
	)		const

inlineinherited

Saves the routable including the vehicle type (if it was not saved before).

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

Exceptions

IOError If something fails (not yet implemented)

Definition at line 131 of file RORoutable.h.

References RORoutable::saveAsXML().

Referenced by RONet::saveAndRemoveRoutesUntil().

Field Documentation

§ myParameter

SUMOVehicleParameter RORoutable::myParameter

protectedinherited

The vehicle's parameter.

Definition at line 165 of file RORoutable.h.

Referenced by addStop(), RORoutable::getDepart(), getDepartureTime(), RORoutable::getID(), getParameter(), ROVehicle(), saveAsXML(), and ROPerson::saveAsXML().

§ myRoute

RORouteDef* const ROVehicle::myRoute

private

The route the vehicle takes.

Definition at line 153 of file ROVehicle.h.

Referenced by addStop(), getDepartEdge(), getRouteDefinition(), and saveAsXML().

§ myRoutingSuccess

bool RORoutable::myRoutingSuccess

protectedinherited

Whether the last routing was successful.

Definition at line 171 of file RORoutable.h.

Referenced by ROPerson::computeIntermodal(), computeRoute(), ROPerson::computeRoute(), and RORoutable::getRoutingSuccess().

§ myStopEdges

ConstROEdgeVector ROVehicle::myStopEdges

private

The edges where the vehicle stops.

Definition at line 156 of file ROVehicle.h.

Referenced by addStop(), getStopEdges(), and ROVehicle().

§ myType

const SUMOVTypeParameter* const RORoutable::myType

protectedinherited

The type of the vehicle.

Definition at line 168 of file RORoutable.h.

Referenced by ROPerson::computeIntermodal(), RORoutable::getMaxSpeed(), RORoutable::getType(), saveAsXML(), and ROPerson::saveAsXML().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

§ ROVehicle() [1/2]

§ ~ROVehicle()

§ ROVehicle() [2/2]

Member Function Documentation

§ addStop()

§ computeRoute()

§ getChosenSpeedFactor()

§ getDepart()

§ getDepartEdge()

§ getDepartureTime()

§ getID()

§ getMaxSpeed()

§ getParameter()

§ getRouteDefinition()

§ getRoutingSuccess()

§ getStopEdges()

§ getType()

§ getVClass()

§ operator=()

§ saveAsXML()

§ write()

Field Documentation

§ myParameter

§ myRoute

§ myRoutingSuccess

§ myStopEdges

§ myType