Base class for a vehicle's route definition. More...

#include <RORouteDef.h>

Inheritance diagram for RORouteDef:

Public Member Functions
virtual void	addAlternative (SUMOAbstractRouter< ROEdge, ROVehicle > &router, const ROVehicle const, RORoute current, SUMOTime begin)=0
	Adds an alternative to the list of routes.
virtual RORoute *	buildCurrentRoute (SUMOAbstractRouter< ROEdge, ROVehicle > &router, SUMOTime begin, const ROVehicle &veh) const =0
	Builds the complete route.
virtual RORouteDef *	copy (const std::string &id) const =0
	Returns a copy of the route definition.
const RGBColor *	getColor () const
	Returns the color of the route.
const std::string &	getID () const
	Returns the id.
bool	isSaved () const
	Returns the information whether this item was already saved.
void	markSaved ()
	Marks the item as saved.
	RORouteDef (const std::string &id, const RGBColor *const color)
	Constructor.
void	setID (const std::string &newID)
	resets the id
virtual OutputDevice &	writeXMLDefinition (SUMOAbstractRouter< ROEdge, ROVehicle > &router, OutputDevice &dev, const ROVehicle *const veh, bool asAlternatives, bool withExitTimes) const =0
	Saves the built route / route alternatives.
virtual	~RORouteDef ()
	Destructor.
Protected Member Functions
const RGBColor *	copyColorIfGiven () const
Protected Attributes
const RGBColor *const	myColor
	The color the route shall have.
std::string	myID
	The name of the object.
Private Member Functions
RORouteDef &	operator= (const RORouteDef &src)
	Invalidated assignment operator.
	RORouteDef (const RORouteDef &src)
	Invalidated copy constructor.

Detailed Description

Base class for a vehicle's route definition.

This class resembles what a vehicle knows about his route when being loaded into a router. Whether it is just the origin and the destination, the whole route through the network or even a route with alternatives depends on the derived class.

Definition at line 64 of file RORouteDef.h.

Constructor & Destructor Documentation

RORouteDef::RORouteDef	(	const std::string &	id,
		const RGBColor *const	color
	)

Constructor.

Parameters:

[in]	id	The id of the route
[in]	color	The color of the route

Definition at line 54 of file RORouteDef.cpp.

RORouteDef::~RORouteDef ( ) [virtual]

Destructor.

Definition at line 59 of file RORouteDef.cpp.

References myColor.

RORouteDef::RORouteDef ( const RORouteDef & src ) [private]

Invalidated copy constructor.

Member Function Documentation

virtual void RORouteDef::addAlternative	(	SUMOAbstractRouter< ROEdge, ROVehicle > &	router,
		const ROVehicle *	const,
		RORoute *	current,
		SUMOTime	begin
	)		`[pure virtual]`

Adds an alternative to the list of routes.

(This may be the new route)

Implemented in RORouteDef_Alternatives, RORouteDef_Complete, and RORouteDef_OrigDest.

Referenced by RONet::computeRoute().

virtual RORoute* RORouteDef::buildCurrentRoute	(	SUMOAbstractRouter< ROEdge, ROVehicle > &	router,
		SUMOTime	begin,
		const ROVehicle &	veh
	)		const `[pure virtual]`

Builds the complete route.

(or chooses her from the list of alternatives, when existing)

Implemented in RORouteDef_Alternatives, RORouteDef_Complete, and RORouteDef_OrigDest.

Referenced by RONet::computeRoute().

virtual RORouteDef* RORouteDef::copy ( const std::string & id ) const [pure virtual]

Returns a copy of the route definition.

Implemented in RORouteDef_Alternatives, RORouteDef_Complete, and RORouteDef_OrigDest.

Referenced by RORDGenerator_ODAmounts::FlowDef::addSingleRoute().

const RGBColor * RORouteDef::copyColorIfGiven ( ) const [protected]

Definition at line 65 of file RORouteDef.cpp.

References myColor.

Referenced by RORouteDef_OrigDest::buildCurrentRoute(), RORouteDef_Complete::buildCurrentRoute(), RORouteDef_Alternatives::buildCurrentRoute(), RORouteDef_OrigDest::copy(), and RORouteDef_Complete::copy().

const RGBColor* RORouteDef::getColor ( ) const [inline]

Returns the color of the route.

Definition at line 94 of file RORouteDef.h.

References myColor.

const std::string& Named::getID ( ) const [inline, inherited]

Returns the id.

Returns:: The stored id

Reimplemented in MS_E2_ZS_CollectorOverLanes.

Definition at line 61 of file Named.h.

References Named::myID.

Referenced by ShapeContainer::add(), MSDetectorControl::add(), RORouteDef_Alternatives::addAlternative(), MSNet::addBusStop(), NLHandler::addConnection(), NBLoadedSUMOTLDef::addConnection(), NIImporter_OpenDrive::addE2EConnectionsSecure(), RONet::addNode(), NIImporter_SUMO::addPhase(), RONet::addRouteDef(), NBDistrict::addSink(), NBDistrict::addSource(), MSRouteHandler::addStop(), NIXMLTrafficLightsHandler::addTlConnection(), NIVissimDisturbance::addToNode(), MSVehicle::addTraciStop(), NIVisumTL::build(), MS_E2_ZS_CollectorOverLanes::buildCollector(), RORouteDef_Complete::buildCurrentRoute(), NIImporter_VISUM::buildDistrictNode(), NIVissimConnection::buildEdgeConnections(), NBEdge::buildInnerEdges(), NIVissimEdge::buildNBEdge(), NBNodeCont::buildOffRamp(), NBNodeCont::buildOnRamp(), ODDistrictHandler::closeDistrict(), NBTrafficLightDefinition::collectEdges(), NBOwnTLDef::collectLinks(), NBTrafficLightDefinition::compute(), NBNode::computeInternalLaneShape(), NBEdge::computeLaneShapes(), NBNode::computeLogic(), NBNode::computeNodeShape(), NBTrafficLightLogicCont::computeSingleLogic(), NBEdge::connections_sorter(), MSLane::detectCollisions(), NIVissimDistrictConnection::dict_BuildDistricts(), MSE3Collector::enter(), MSVTypeProbe::execute(), Command_SaveTLSSwitches::execute(), NBTrafficLightLogicCont::extract(), NBNodeCont::extract(), NBEdgeCont::extract(), MSNet::getBusStopID(), NIImporter_VISUM::getNamedEdgeContinuating(), NLTriggerBuilder::getPosition(), NBNode::getPossiblySplittedIncoming(), NBNode::getPossiblySplittedOutgoing(), NIImporter_VISUM::getReversedContinuating(), NBEdgeCont::ignoreFilterMatch(), MSUnboundActuatedTrafficLightLogic::init(), MSAgentbasedTrafficLightLogic::init(), MSActuatedTrafficLightLogic::init(), NIXMLTrafficLightsHandler::initTrafficLightLogic(), NIImporter_SUMO::initTrafficLightLogic(), NBTrafficLightLogicCont::insert(), NBNodeCont::insert(), NBEdgeCont::insert(), NBDistrictCont::insert(), NBNodeCont::joinJunctions(), NBEdgeCont::joinSameNodeConnectingEdges(), MSE3Collector::leave(), NIImporter_OpenDrive::loadNetwork(), MSLane::moveCritical(), MSVehicle::MSVehicle(), RORDLoader_SUMOBase::myCharacters(), NBOwnTLDef::myCompute(), NBLoadedTLDef::myCompute(), NIXMLTrafficLightsHandler::myEndElement(), NIXMLEdgesHandler::myEndElement(), NIImporter_SUMO::myEndElement(), NIXMLConnectionsHandler::myStartElement(), MSTriggeredRerouter::myStartElement(), MSLaneSpeedTrigger::myStartElement(), NBConnection::NBConnection(), NBRequest::NBRequest(), MSDevice_Tripinfo::notifyEnter(), MSDevice_Tripinfo::notifyLeave(), NBOwnTLDef::edge_by_incoming_priority_sorter::operator()(), NBNode::nodes_by_id_sorter::operator()(), NBNetBuilder::by_id_sorter::operator()(), NBContHelper::same_connection_edge_sorter::operator()(), Named::ComparatorIdLess::operator()(), NIImporter_VISUM::parse_EdgePolys(), NIImporter_VISUM::parse_Lanes(), NIImporter_VISUM::parse_LanesConnections(), NIImporter_VISUM::parse_Turns(), NIImporter_VISUM::parse_TurnsToSignalGroups(), NIXMLConnectionsHandler::parseDeprecatedLaneDefinition(), NIXMLConnectionsHandler::parseLaneBound(), NBLoadedTLDef::SignalGroup::patchTYellow(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_TLS::processGet(), TraCIServerAPI_Lane::processGet(), TraCIServerAPI_InductionLoop::processGet(), NWWriter_SUMO::prohibitionConnection(), NBLoadedTLDef::SignalGroup::remapIncoming(), NBLoadedTLDef::SignalGroup::remapOutgoing(), NBLoadedSUMOTLDef::removeConnection(), NBNode::removeSelfLoops(), NBEdgeCont::removeUnwishedEdges(), NBNodeCont::removeUnwishedNodes(), NBConnection::replaceFrom(), MSBaseVehicle::replaceRouteEdges(), NBConnection::replaceTo(), NIXMLTrafficLightsHandler::retrieveLaneIndex(), NBNodeCont::setAsTLControlled(), NBEdge::setControllingTLInformation(), MSLane::setCritical(), NIXMLEdgesHandler::setNodes(), NBOwnTLDef::setTLControllingInformation(), NBLoadedTLDef::setTLControllingInformation(), NBLoadedSUMOTLDef::setTLControllingInformation(), NBEdgeCont::splitAt(), RORDLoader_SUMOBase::startRoute(), NBEdge::startShapeAt(), NIXMLConnectionsHandler::validateLaneInfo(), MSInstantInductLoop::write(), NWWriter_SUMO::writeConnection(), NWWriter_SUMO::writeDistrict(), NWWriter_SUMO::writeEdge(), MSMeanData::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), NWWriter_SUMO::writeInternalConnections(), NWWriter_SUMO::writeJunction(), NWWriter_OpenDrive::writeNetwork(), NWWriter_XML::writeNodes(), MSInductLoop::writeTypedXMLOutput(), MSRouteProbe::writeXMLOutput(), and MSE2Collector::writeXMLOutput().

bool ReferencedItem::isSaved ( ) const [inline, inherited]

Returns the information whether this item was already saved.

Returns:: Whether this item was saved

Definition at line 59 of file ReferencedItem.h.

References ReferencedItem::myWasSaved.

Referenced by RONet::computeRoute(), and ROVehicle::saveAllAsXML().

void ReferencedItem::markSaved ( ) [inline, inherited]

Marks the item as saved.

Definition at line 66 of file ReferencedItem.h.

References ReferencedItem::myWasSaved.

RORouteDef& RORouteDef::operator= ( const RORouteDef & src ) [private]

Invalidated assignment operator.

void Named::setID ( const std::string & newID ) [inline, inherited]

resets the id

Definition at line 67 of file Named.h.

References Named::myID.

virtual OutputDevice& RORouteDef::writeXMLDefinition	(	SUMOAbstractRouter< ROEdge, ROVehicle > &	router,
		OutputDevice &	dev,
		const ROVehicle *const	veh,
		bool	asAlternatives,
		bool	withExitTimes
	)		const `[pure virtual]`