#include <MSNet.h>

Inheritance diagram for IntermodalRouter< E, L, N, V >:

Collaboration diagram for IntermodalRouter< E, L, N, V >:

Data Structures
struct	TripItem

Public Types
typedef IntermodalNetwork< E, L, N, V >	Network

typedef double(*	Operation) (const E const, const IntermodalTrip< E, N, V > const, double)
	Type of the function that is used to retrieve the edge effort. More...

Public Member Functions
SUMOAbstractRouter< E, _IntermodalTrip > *	clone ()

bool	compute (const E from, const E to, const double departPos, const double arrivalPos, const std::string stopID, const double speed, const V *const vehicle, const SVCPermissions modeSet, const SUMOTime msTime, std::vector< TripItem > &into, const double externalFactor=0.)
	Builds the route between the given edges using the minimum effort at the given time The definition of the effort depends on the wished routing scheme. More...

bool	compute (const E , const E , const _IntermodalTrip const, SUMOTime, std::vector< const E > &)
	Builds the route between the given edges using the minimum effort at the given time The definition of the effort depends on the wished routing scheme. More...

void	endQuery (int visits)

double	getEffort (const E const e, const IntermodalTrip< E, N, V > const v, double t) const

Network *	getNetwork () const

double	getTravelTime (const E const e, const IntermodalTrip< E, N, V > const v, const double t, const double effort) const

	IntermodalRouter (CreateNetCallback callback, const int carWalkTransfer, const std::string &routingAlgorithm, const int routingMode=0, EffortCalculator *calc=nullptr)
	Constructor. More...

virtual bool	isProhibited (const E const, const IntermodalTrip< E, N, V > const) const

void	prohibit (const std::vector< E *> &toProhibit)

double	recomputeCosts (const std::vector< const E * > &edges, const IntermodalTrip< E, N, V > *const v, SUMOTime msTime) const

void	setBulkMode (const bool mode)

void	startQuery ()

void	updateViaCost (const E const prev, const E const e, const IntermodalTrip< E, N, V > *const v, double &time, double &effort) const

void	writeNetwork (OutputDevice &dev)

void	writeWeights (OutputDevice &dev)

virtual	~IntermodalRouter ()
	Destructor. More...

Protected Attributes
bool	myBulkMode
	whether we are currently operating several route queries in a bulk More...

Operation	myOperation
	The object's operation to perform. More...

Operation	myTTOperation
	The object's operation to perform for travel times. More...

Private Types
typedef IntermodalEdge< E, L, N, V >	_IntermodalEdge

typedef IntermodalTrip< E, N, V >	_IntermodalTrip

typedef AStarRouter< IntermodalEdge< E, L, N, V >, IntermodalTrip< E, N, V >, SUMOAbstractRouterPermissions< IntermodalEdge< E, L, N, V >, IntermodalTrip< E, N, V > > >	_InternalAStar

typedef DijkstraRouter< IntermodalEdge< E, L, N, V >, IntermodalTrip< E, N, V >, SUMOAbstractRouterPermissions< IntermodalEdge< E, L, N, V >, IntermodalTrip< E, N, V > > >	_InternalDijkstra

typedef SUMOAbstractRouterPermissions< IntermodalEdge< E, L, N, V >, IntermodalTrip< E, N, V > >	_InternalRouter

typedef void(*	CreateNetCallback) (IntermodalRouter< E, L, N, V > &)

Private Member Functions
void	createNet ()

	IntermodalRouter (Network net, const int carWalkTransfer, const std::string &routingAlgorithm, const int routingMode, EffortCalculator calc)

IntermodalRouter &	operator= (const IntermodalRouter &s)
	Invalidated assignment operator. More...

Static Private Member Functions
static double	getCombined (const _IntermodalEdge const edge, const _IntermodalTrip const trip, double time)

static double	getEffortAggregated (const _IntermodalEdge const edge, const _IntermodalTrip const trip, double time)

Private Attributes
const bool	myAmClone

CreateNetCallback	myCallback

const int	myCarWalkTransfer

EffortCalculator *const	myExternalEffort

Network *	myIntermodalNet

_InternalRouter *	myInternalRouter

const std::string	myRoutingAlgorithm

const int	myRoutingMode

Detailed Description

template<class E, class L, class N, class V>
class IntermodalRouter< E, L, N, V >

The router for pedestrians (on a bidirectional network of sidewalks and crossings)

Definition at line 73 of file MSNet.h.

Member Typedef Documentation

◆ _IntermodalEdge

template<class E, class L, class N, class V>

typedef IntermodalEdge<E, L, N, V> IntermodalRouter< E, L, N, V >::_IntermodalEdge

private

Definition at line 61 of file IntermodalRouter.h.

◆ _IntermodalTrip

template<class E, class L, class N, class V>

typedef IntermodalTrip<E, N, V> IntermodalRouter< E, L, N, V >::_IntermodalTrip

private

Definition at line 62 of file IntermodalRouter.h.

◆ _InternalAStar

template<class E, class L, class N, class V>

typedef AStarRouter<IntermodalEdge<E, L, N, V>, IntermodalTrip<E, N, V>, SUMOAbstractRouterPermissions<IntermodalEdge<E, L, N, V>, IntermodalTrip<E, N, V> > > IntermodalRouter< E, L, N, V >::_InternalAStar

private

Definition at line 65 of file IntermodalRouter.h.

◆ _InternalDijkstra

template<class E, class L, class N, class V>

typedef DijkstraRouter<IntermodalEdge<E, L, N, V>, IntermodalTrip<E, N, V>, SUMOAbstractRouterPermissions<IntermodalEdge<E, L, N, V>, IntermodalTrip<E, N, V> > > IntermodalRouter< E, L, N, V >::_InternalDijkstra

private

Definition at line 64 of file IntermodalRouter.h.

◆ _InternalRouter

template<class E, class L, class N, class V>

typedef SUMOAbstractRouterPermissions<IntermodalEdge<E, L, N, V>, IntermodalTrip<E, N, V> > IntermodalRouter< E, L, N, V >::_InternalRouter

private

Definition at line 63 of file IntermodalRouter.h.

◆ CreateNetCallback

template<class E, class L, class N, class V>

typedef void(* IntermodalRouter< E, L, N, V >::CreateNetCallback) (IntermodalRouter< E, L, N, V > &)

private

Definition at line 60 of file IntermodalRouter.h.

◆ Network

template<class E, class L, class N, class V>

typedef IntermodalNetwork<E, L, N, V> IntermodalRouter< E, L, N, V >::Network

Definition at line 57 of file IntermodalRouter.h.

◆ Operation

typedef double(* SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::Operation) (const E *const, const IntermodalTrip< E, N, V > *const, double)

inherited

Type of the function that is used to retrieve the edge effort.

Definition at line 49 of file SUMOAbstractRouter.h.

Constructor & Destructor Documentation

◆ IntermodalRouter() [1/2]

template<class E, class L, class N, class V>

IntermodalRouter< E, L, N, V >::IntermodalRouter	(	CreateNetCallback	callback,
		const int	carWalkTransfer,
		const std::string &	routingAlgorithm,
		const int	routingMode = `0`,
		EffortCalculator *	calc = `nullptr`
	)

inline

Constructor.

Definition at line 84 of file IntermodalRouter.h.

◆ ~IntermodalRouter()

template<class E, class L, class N, class V>

virtual IntermodalRouter< E, L, N, V >::~IntermodalRouter ( )

inlinevirtual

Destructor.

Definition at line 93 of file IntermodalRouter.h.

References IntermodalRouter< E, L, N, V >::myAmClone, IntermodalRouter< E, L, N, V >::myIntermodalNet, and IntermodalRouter< E, L, N, V >::myInternalRouter.

◆ IntermodalRouter() [2/2]

template<class E, class L, class N, class V>

IntermodalRouter< E, L, N, V >::IntermodalRouter	(	Network *	net,
		const int	carWalkTransfer,
		const std::string &	routingAlgorithm,
		const int	routingMode,
		EffortCalculator *	calc
	)

inlineprivate

Definition at line 222 of file IntermodalRouter.h.

Member Function Documentation

◆ clone()

template<class E, class L, class N, class V>

SUMOAbstractRouter<E, _IntermodalTrip>* IntermodalRouter< E, L, N, V >::clone ( )

inlinevirtual

Implements SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >.

Definition at line 100 of file IntermodalRouter.h.

References IntermodalRouter< E, L, N, V >::createNet(), IntermodalRouter< E, L, N, V >::myCarWalkTransfer, IntermodalRouter< E, L, N, V >::myExternalEffort, IntermodalRouter< E, L, N, V >::myIntermodalNet, IntermodalRouter< E, L, N, V >::myRoutingAlgorithm, and IntermodalRouter< E, L, N, V >::myRoutingMode.

◆ compute() [1/2]

template<class E, class L, class N, class V>

bool IntermodalRouter< E, L, N, V >::compute	(	const E *	from,
		const E *	to,
		const double	departPos,
		const double	arrivalPos,
		const std::string	stopID,
		const double	speed,
		const V *const	vehicle,
		const SVCPermissions	modeSet,
		const SUMOTime	msTime,
		std::vector< TripItem > &	into,
		const double	externalFactor = `0.`
	)

inline

Builds the route between the given edges using the minimum effort at the given time The definition of the effort depends on the wished routing scheme.

Definition at line 107 of file IntermodalRouter.h.

References IntermodalTrip< E, N, V >::arrivalPos, SUMOAbstractRouter< E, V >::compute(), IntermodalRouter< E, L, N, V >::createNet(), IntermodalTrip< E, N, V >::departPos, IntermodalNetwork< E, L, N, V >::getArrivalEdge(), IntermodalNetwork< E, L, N, V >::getDepartEdge(), SUMOAbstractRouter< E, V >::getEffort(), IntermodalNetwork< E, L, N, V >::getStopEdge(), IntermodalRouter< E, L, N, V >::myExternalEffort, IntermodalRouter< E, L, N, V >::myIntermodalNet, IntermodalRouter< E, L, N, V >::myInternalRouter, STEPS2TIME, TIME2STEPS, toString(), IntermodalRouter< E, L, N, V >::TripItem::TripItem(), and SUMOAbstractRouter< E, V >::updateViaCost().

Referenced by libsumo::Simulation::findIntermodalRoute().

◆ compute() [2/2]

template<class E, class L, class N, class V>

bool IntermodalRouter< E, L, N, V >::compute	(	const E *	,
		const E *	,
		const _IntermodalTrip *	const,
		SUMOTime	,
		std::vector< const E *> &
	)

inlinevirtual

Builds the route between the given edges using the minimum effort at the given time The definition of the effort depends on the wished routing scheme.

Implements SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >.

Definition at line 177 of file IntermodalRouter.h.

◆ createNet()

template<class E, class L, class N, class V>

void IntermodalRouter< E, L, N, V >::createNet ( )

inlineprivate

Definition at line 236 of file IntermodalRouter.h.

Referenced by IntermodalRouter< E, L, N, V >::clone(), IntermodalRouter< E, L, N, V >::compute(), IntermodalRouter< E, L, N, V >::prohibit(), IntermodalRouter< E, L, N, V >::writeNetwork(), and IntermodalRouter< E, L, N, V >::writeWeights().

◆ endQuery()

void SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::endQuery ( int visits )

inlineinherited

Definition at line 130 of file SUMOAbstractRouter.h.

References SysUtils::getCurrentMillis(), SUMOAbstractRouter< E, V >::myQueryStartTime, SUMOAbstractRouter< E, V >::myQueryTimeSum, and SUMOAbstractRouter< E, V >::myQueryVisits.

◆ getCombined()

template<class E, class L, class N, class V>

static double IntermodalRouter< E, L, N, V >::getCombined	(	const _IntermodalEdge *const	edge,
		const _IntermodalTrip *const	trip,
		double	time
	)

inlinestaticprivate

Definition at line 232 of file IntermodalRouter.h.

References IntermodalTrip< E, N, V >::calc, IntermodalTrip< E, N, V >::externalFactor, EffortCalculator::getEffort(), IntermodalEdge< E, L, N, V >::getNumericalID(), and IntermodalEdge< E, L, N, V >::getTravelTime().

Referenced by IntermodalRouter< E, L, N, V >::createNet().

◆ getEffort()

double SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::getEffort	(	const E *const	e,
		const IntermodalTrip< E, N, V > *const	v,
		double	t
	)		const

inlineinherited

Definition at line 121 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myOperation.

◆ getEffortAggregated()

template<class E, class L, class N, class V>

static double IntermodalRouter< E, L, N, V >::getEffortAggregated	(	const _IntermodalEdge *const	edge,
		const _IntermodalTrip *const	trip,
		double	time
	)

inlinestaticprivate

Definition at line 228 of file IntermodalRouter.h.

References IntermodalEdge< E, L, N, V >::getEffort(), and IntermodalEdge< E, L, N, V >::hasEffort().

Referenced by IntermodalRouter< E, L, N, V >::createNet().

◆ getNetwork()

template<class E, class L, class N, class V>

Network* IntermodalRouter< E, L, N, V >::getNetwork ( ) const

inline

Definition at line 217 of file IntermodalRouter.h.

References IntermodalRouter< E, L, N, V >::myIntermodalNet.

Referenced by MSInsertionControl::adaptIntermodalRouter(), RONet::adaptIntermodalRouter(), MSVehicleControl::adaptIntermodalRouter(), and MSNet::adaptIntermodalRouter().

◆ getTravelTime()

double SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::getTravelTime	(	const E *const	e,
		const IntermodalTrip< E, N, V > *const	v,
		const double	t,
		const double	effort
	)		const

inlineinherited

Definition at line 81 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myTTOperation.

◆ isProhibited()

virtual bool SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::isProhibited	(	const E *	const,
		const IntermodalTrip< E, N, V > *	const
	)		const

inlinevirtualinherited

Definition at line 77 of file SUMOAbstractRouter.h.

◆ operator=()

template<class E, class L, class N, class V>

IntermodalRouter& IntermodalRouter< E, L, N, V >::operator= ( const IntermodalRouter< E, L, N, V > & s )

private

Invalidated assignment operator.

◆ prohibit()

template<class E, class L, class N, class V>

void IntermodalRouter< E, L, N, V >::prohibit ( const std::vector< E *> & toProhibit )

inline

Definition at line 182 of file IntermodalRouter.h.

References IntermodalRouter< E, L, N, V >::createNet(), IntermodalNetwork< E, L, N, V >::getBothDirections(), IntermodalNetwork< E, L, N, V >::getCarEdge(), IntermodalRouter< E, L, N, V >::myIntermodalNet, IntermodalRouter< E, L, N, V >::myInternalRouter, and SUMOAbstractRouterPermissions< E, V >::prohibit().

◆ recomputeCosts()

double SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::recomputeCosts	(	const std::vector< const E *> &	edges,
		const IntermodalTrip< E, N, V > *const	v,
		SUMOTime	msTime
	)		const

inlineinherited

Definition at line 106 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::isProhibited(), STEPS2TIME, and SUMOAbstractRouter< E, V >::updateViaCost().

◆ setBulkMode()

void SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::setBulkMode ( const bool mode )

inlineinherited

Definition at line 135 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myBulkMode.

◆ startQuery()

void SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::startQuery ( )

inlineinherited

Definition at line 125 of file SUMOAbstractRouter.h.

References SysUtils::getCurrentMillis(), SUMOAbstractRouter< E, V >::myNumQueries, and SUMOAbstractRouter< E, V >::myQueryStartTime.

◆ updateViaCost()

void SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::updateViaCost	(	const E *const	prev,
		const E *const	e,
		const IntermodalTrip< E, N, V > *const	v,
		double &	time,
		double &	effort
	)		const

inlineinherited

Definition at line 85 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::getEffort(), and SUMOAbstractRouter< E, V >::getTravelTime().

◆ writeNetwork()

template<class E, class L, class N, class V>

void IntermodalRouter< E, L, N, V >::writeNetwork ( OutputDevice & dev )

inline

Definition at line 193 of file IntermodalRouter.h.

References OutputDevice::closeTag(), IntermodalRouter< E, L, N, V >::createNet(), IntermodalNetwork< E, L, N, V >::getAllEdges(), IntermodalRouter< E, L, N, V >::myIntermodalNet, OutputDevice::openTag(), SUMO_ATTR_ID, SUMO_ATTR_LENGTH, SUMO_ATTR_LINE, SUMO_TAG_EDGE, SVC_IGNORING, toString(), and OutputDevice::writeAttr().

Referenced by RONet::writeIntermodal().

◆ writeWeights()

template<class E, class L, class N, class V>

void IntermodalRouter< E, L, N, V >::writeWeights ( OutputDevice & dev )

inline

Definition at line 205 of file IntermodalRouter.h.

References OutputDevice::closeTag(), IntermodalRouter< E, L, N, V >::createNet(), DEFAULT_PEDESTRIAN_SPEED, IntermodalNetwork< E, L, N, V >::getAllEdges(), IntermodalRouter< E, L, N, V >::myIntermodalNet, OutputDevice::openTag(), SUMO_ATTR_ID, SUMO_TAG_EDGE, SVC_BICYCLE, SVC_BUS, SVC_PASSENGER, and OutputDevice::writeAttr().

Referenced by RONet::writeIntermodal().

Field Documentation

◆ myAmClone

template<class E, class L, class N, class V>

const bool IntermodalRouter< E, L, N, V >::myAmClone

private

Definition at line 270 of file IntermodalRouter.h.

Referenced by IntermodalRouter< E, L, N, V >::~IntermodalRouter().

◆ myBulkMode

bool SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::myBulkMode

protectedinherited

whether we are currently operating several route queries in a bulk

Definition at line 147 of file SUMOAbstractRouter.h.

◆ myCallback

template<class E, class L, class N, class V>

CreateNetCallback IntermodalRouter< E, L, N, V >::myCallback

private

Definition at line 273 of file IntermodalRouter.h.

Referenced by IntermodalRouter< E, L, N, V >::createNet().

◆ myCarWalkTransfer

template<class E, class L, class N, class V>

const int IntermodalRouter< E, L, N, V >::myCarWalkTransfer

private

Definition at line 274 of file IntermodalRouter.h.

Referenced by IntermodalRouter< E, L, N, V >::clone(), and IntermodalRouter< E, L, N, V >::createNet().

◆ myExternalEffort

template<class E, class L, class N, class V>

EffortCalculator* const IntermodalRouter< E, L, N, V >::myExternalEffort

private

Definition at line 277 of file IntermodalRouter.h.

Referenced by IntermodalRouter< E, L, N, V >::clone(), IntermodalRouter< E, L, N, V >::compute(), and IntermodalRouter< E, L, N, V >::createNet().

◆ myIntermodalNet

template<class E, class L, class N, class V>

Network* IntermodalRouter< E, L, N, V >::myIntermodalNet

private

Definition at line 272 of file IntermodalRouter.h.

Referenced by IntermodalRouter< E, L, N, V >::clone(), IntermodalRouter< E, L, N, V >::compute(), IntermodalRouter< E, L, N, V >::createNet(), IntermodalRouter< E, L, N, V >::getNetwork(), IntermodalRouter< E, L, N, V >::prohibit(), IntermodalRouter< E, L, N, V >::writeNetwork(), IntermodalRouter< E, L, N, V >::writeWeights(), and IntermodalRouter< E, L, N, V >::~IntermodalRouter().

◆ myInternalRouter

template<class E, class L, class N, class V>

_InternalRouter* IntermodalRouter< E, L, N, V >::myInternalRouter

private

Definition at line 271 of file IntermodalRouter.h.

Referenced by IntermodalRouter< E, L, N, V >::compute(), IntermodalRouter< E, L, N, V >::createNet(), IntermodalRouter< E, L, N, V >::prohibit(), and IntermodalRouter< E, L, N, V >::~IntermodalRouter().

◆ myOperation

Operation SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::myOperation

protectedinherited

The object's operation to perform.

Definition at line 141 of file SUMOAbstractRouter.h.

◆ myRoutingAlgorithm

template<class E, class L, class N, class V>

const std::string IntermodalRouter< E, L, N, V >::myRoutingAlgorithm

private

Definition at line 275 of file IntermodalRouter.h.

Referenced by IntermodalRouter< E, L, N, V >::clone(), and IntermodalRouter< E, L, N, V >::createNet().

◆ myRoutingMode

template<class E, class L, class N, class V>

const int IntermodalRouter< E, L, N, V >::myRoutingMode

private

Definition at line 276 of file IntermodalRouter.h.

Referenced by IntermodalRouter< E, L, N, V >::clone(), and IntermodalRouter< E, L, N, V >::createNet().

◆ myTTOperation

Operation SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::myTTOperation

protectedinherited

The object's operation to perform for travel times.

Definition at line 144 of file SUMOAbstractRouter.h.

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

Data Structures

Public Types

Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

template<class E, class L, class N, class V> class IntermodalRouter< E, L, N, V >

Member Typedef Documentation

◆ _IntermodalEdge

◆ _IntermodalTrip

◆ _InternalAStar

◆ _InternalDijkstra

◆ _InternalRouter

◆ CreateNetCallback

◆ Network

◆ Operation

Constructor & Destructor Documentation

◆ IntermodalRouter() [1/2]

◆ ~IntermodalRouter()

◆ IntermodalRouter() [2/2]

Member Function Documentation

◆ clone()

◆ compute() [1/2]

◆ compute() [2/2]

◆ createNet()

◆ endQuery()

◆ getCombined()

◆ getEffort()

◆ getEffortAggregated()

◆ getNetwork()

◆ getTravelTime()

◆ isProhibited()

◆ operator=()

◆ prohibit()

◆ recomputeCosts()

◆ setBulkMode()

◆ startQuery()

◆ updateViaCost()

◆ writeNetwork()

◆ writeWeights()

Field Documentation

◆ myAmClone

◆ myBulkMode

◆ myCallback

◆ myCarWalkTransfer

◆ myExternalEffort

◆ myIntermodalNet

◆ myInternalRouter

◆ myOperation

◆ myRoutingAlgorithm

◆ myRoutingMode

◆ myTTOperation

template<class E, class L, class N, class V>
class IntermodalRouter< E, L, N, V >