the edge type representing backward edges More...

#include <RailEdge.h>

Collaboration diagram for RailEdge< E, V >:

Public Types
typedef RailEdge< E, V >	_RailEdge

typedef std::vector< std::pair< const _RailEdge , const _RailEdge > >	ConstEdgePairVector

Public Member Functions
void	addVirtualTurns (const E forward, const E backward, std::vector< _RailEdge * > &railEdges, int &numericalID, double dist, double maxTrainLength, const std::vector< const E * > &replacementEdges)

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

double	getLength () const
	Returns the length of the edge.

int	getNumericalID () const
	Returns the index (numeric id) of the edge.

const E *	getOriginal () const
	Returns the original edge.

const ConstEdgePairVector &	getViaSuccessors (SUMOVehicleClass vClass=SVC_IGNORING, bool ignoreTransientPermissions=false) const

void	init (std::vector< _RailEdge * > &railEdges, int &numericalID, double maxTrainLength)

void	insertOriginalEdges (double length, std::vector< const E * > &into) const

bool	isInternal () const

bool	isVirtual () const

bool	prohibits (const V *const vehicle) const

	RailEdge (const E *orig)

	RailEdge (const E turnStart, const E turnEnd, int numericalID)

bool	restricts (const V *const vehicle) const

void	update (double maxTrainLength, const std::vector< const E * > &replacementEdges)

virtual	~RailEdge ()
	Destructor.

Private Attributes
std::map< SUMOVehicleClass, ConstEdgePairVector >	myClassesViaSuccessorMap
	The successors available for a given vClass.

const std::string	myID

bool	myIsVirtual

double	myMaxLength = std::numeric_limits<double>::max()
	maximum train length for passing this (turnaround) edge

const int	myNumericalID

const E *	myOriginal

std::vector< const E * >	myReplacementEdges
	actual edges to return when passing this (turnaround) edge - only forward

double	myStartLength = 0
	length of the edge where this turn starts

_RailEdge *	myTurnaround

ConstEdgePairVector	myViaSuccessors

Detailed Description

template<class E, class V>
class RailEdge< E, V >

the edge type representing backward edges

Definition at line 38 of file RailEdge.h.

Member Typedef Documentation

◆ _RailEdge

template<class E , class V >

typedef RailEdge<E, V> RailEdge< E, V >::_RailEdge

Definition at line 40 of file RailEdge.h.

◆ ConstEdgePairVector

template<class E , class V >

typedef std::vector<std::pair<const _RailEdge*, const _RailEdge*> > RailEdge< E, V >::ConstEdgePairVector

Definition at line 41 of file RailEdge.h.

Constructor & Destructor Documentation

◆ RailEdge() [1/2]

template<class E , class V >

RailEdge< E, V >::RailEdge ( const E * orig )

inline

Definition at line 43 of file RailEdge.h.

◆ RailEdge() [2/2]

template<class E , class V >

RailEdge< E, V >::RailEdge	(	const E *	turnStart,
		const E *	turnEnd,
		int	numericalID
	)

inline

Definition at line 50 of file RailEdge.h.

References RailEdge< E, V >::myViaSuccessors.

◆ ~RailEdge()

template<class E , class V >

virtual RailEdge< E, V >::~RailEdge ( )

inlinevirtual

Destructor.

Definition at line 62 of file RailEdge.h.

References RailEdge< E, V >::myTurnaround.

Member Function Documentation

◆ addVirtualTurns()

template<class E , class V >

void RailEdge< E, V >::addVirtualTurns	(	const E *	forward,
		const E *	backward,
		std::vector< _RailEdge< E, V > * > &	railEdges,
		int &	numericalID,
		double	dist,
		double	maxTrainLength,
		const std::vector< const E * > &	replacementEdges
	)

inline

Definition at line 76 of file RailEdge.h.

References RailEdge< E, V >::addVirtualTurns(), RailEdge< E, V >::getID(), RailEdge< E, V >::myTurnaround, RailEdge< E, V >::myViaSuccessors, REVERSAL_SLACK, SVC_IGNORING, toString(), and RailEdge< E, V >::update().

Referenced by RailEdge< E, V >::addVirtualTurns(), and RailEdge< E, V >::init().

Here is the caller graph for this function:

◆ getID()

template<class E , class V >

const std::string & RailEdge< E, V >::getID ( ) const

inline

Returns the id of the edge.

Returns: The original edge's id

Definition at line 177 of file RailEdge.h.

References RailEdge< E, V >::myID, and RailEdge< E, V >::myOriginal.

Referenced by RailEdge< E, V >::addVirtualTurns(), RailEdge< E, V >::init(), RailEdge< E, V >::prohibits(), and RailEdge< E, V >::update().

Here is the caller graph for this function:

◆ getLength()

template<class E , class V >

double RailEdge< E, V >::getLength ( ) const

inline

Returns the length of the edge.

Returns: The original edge's length

Definition at line 211 of file RailEdge.h.

References RailEdge< E, V >::myOriginal.

Referenced by RailEdge< E, V >::init().

Here is the caller graph for this function:

◆ getNumericalID()

template<class E , class V >

int RailEdge< E, V >::getNumericalID ( ) const

inline

Returns the index (numeric id) of the edge.

Definition at line 165 of file RailEdge.h.

References RailEdge< E, V >::myNumericalID.

◆ getOriginal()

template<class E , class V >

const E * RailEdge< E, V >::getOriginal ( ) const

inline

Returns the original edge.

Definition at line 170 of file RailEdge.h.

References RailEdge< E, V >::myOriginal.

Referenced by RailwayRouter< E, V >::getTravelTimeStatic().

Here is the caller graph for this function:

◆ getViaSuccessors()

template<class E , class V >

const ConstEdgePairVector & RailEdge< E, V >::getViaSuccessors	(	SUMOVehicleClass	vClass = `SVC_IGNORING`,
		bool	ignoreTransientPermissions = `false`
	)		const

inline

Definition at line 236 of file RailEdge.h.

References RailEdge< E, V >::myClassesViaSuccessorMap, RailEdge< E, V >::myOriginal, RailEdge< E, V >::myViaSuccessors, SVC_IGNORING, and UNUSED_PARAMETER.

◆ init()

template<class E , class V >

void RailEdge< E, V >::init	(	std::vector< _RailEdge< E, V > * > &	railEdges,
		int &	numericalID,
		double	maxTrainLength
	)

inline

Definition at line 129 of file RailEdge.h.

References RailEdge< E, V >::addVirtualTurns(), RailEdge< E, V >::getID(), RailEdge< E, V >::getLength(), MAX2(), RailEdge< E, V >::myIsVirtual, RailEdge< E, V >::myOriginal, RailEdge< E, V >::myTurnaround, and RailEdge< E, V >::myViaSuccessors.

◆ insertOriginalEdges()

template<class E , class V >

void RailEdge< E, V >::insertOriginalEdges	(	double	length,
		std::vector< const E * > &	into
	)		const

inline

Definition at line 181 of file RailEdge.h.

References RailEdge< E, V >::myIsVirtual, RailEdge< E, V >::myOriginal, RailEdge< E, V >::myReplacementEdges, RailEdge< E, V >::myStartLength, REVERSAL_SLACK, and SVC_IGNORING.

Referenced by RailwayRouter< E, V >::getTravelTimeStatic().

Here is the caller graph for this function:

◆ isInternal()

template<class E , class V >

bool RailEdge< E, V >::isInternal ( ) const

inline

Definition at line 219 of file RailEdge.h.

References RailEdge< E, V >::myOriginal.

◆ isVirtual()

template<class E , class V >

bool RailEdge< E, V >::isVirtual ( ) const

inline

Definition at line 262 of file RailEdge.h.

References RailEdge< E, V >::myIsVirtual.

Referenced by RailwayRouter< E, V >::getTravelTimeStatic().

Here is the caller graph for this function:

◆ prohibits()

template<class E , class V >

bool RailEdge< E, V >::prohibits ( const V *const vehicle ) const

inline

Definition at line 223 of file RailEdge.h.

References RailEdge< E, V >::getID(), RailEdge< E, V >::myMaxLength, RailEdge< E, V >::myOriginal, and RailEdge_DEBUG_COND.

◆ restricts()

template<class E , class V >

bool RailEdge< E, V >::restricts ( const V *const vehicle ) const

inline

Definition at line 232 of file RailEdge.h.

References RailEdge< E, V >::myOriginal.

◆ update()

template<class E , class V >

void RailEdge< E, V >::update	(	double	maxTrainLength,
		const std::vector< const E * > &	replacementEdges
	)

inline

Definition at line 66 of file RailEdge.h.

References RailEdge< E, V >::getID(), RailEdge< E, V >::myMaxLength, RailEdge< E, V >::myReplacementEdges, and toString().

Referenced by RailEdge< E, V >::addVirtualTurns().

Here is the caller graph for this function:

Field Documentation

◆ myClassesViaSuccessorMap

template<class E , class V >

std::map<SUMOVehicleClass, ConstEdgePairVector> RailEdge< E, V >::myClassesViaSuccessorMap

mutableprivate

The successors available for a given vClass.

Definition at line 282 of file RailEdge.h.

Referenced by RailEdge< E, V >::getViaSuccessors().

◆ myID

template<class E , class V >

const std::string RailEdge< E, V >::myID

private

Definition at line 268 of file RailEdge.h.

Referenced by RailEdge< E, V >::getID().

◆ myIsVirtual

template<class E , class V >

bool RailEdge< E, V >::myIsVirtual

private

Definition at line 271 of file RailEdge.h.

Referenced by RailEdge< E, V >::init(), RailEdge< E, V >::insertOriginalEdges(), and RailEdge< E, V >::isVirtual().

◆ myMaxLength

template<class E , class V >

double RailEdge< E, V >::myMaxLength = std::numeric_limits<double>::max()

private

maximum train length for passing this (turnaround) edge

Definition at line 277 of file RailEdge.h.

Referenced by RailEdge< E, V >::prohibits(), and RailEdge< E, V >::update().

◆ myNumericalID

template<class E , class V >

const int RailEdge< E, V >::myNumericalID

private

Definition at line 267 of file RailEdge.h.

Referenced by RailEdge< E, V >::getNumericalID().

◆ myOriginal

template<class E , class V >

const E* RailEdge< E, V >::myOriginal

private

Definition at line 269 of file RailEdge.h.

Referenced by RailEdge< E, V >::getID(), RailEdge< E, V >::getLength(), RailEdge< E, V >::getOriginal(), RailEdge< E, V >::getViaSuccessors(), RailEdge< E, V >::init(), RailEdge< E, V >::insertOriginalEdges(), RailEdge< E, V >::isInternal(), RailEdge< E, V >::prohibits(), and RailEdge< E, V >::restricts().

◆ myReplacementEdges

template<class E , class V >

std::vector<const E*> RailEdge< E, V >::myReplacementEdges

private

actual edges to return when passing this (turnaround) edge - only forward

Definition at line 274 of file RailEdge.h.

Referenced by RailEdge< E, V >::insertOriginalEdges(), and RailEdge< E, V >::update().

◆ myStartLength

template<class E , class V >

double RailEdge< E, V >::myStartLength = 0

private

length of the edge where this turn starts

Definition at line 279 of file RailEdge.h.

Referenced by RailEdge< E, V >::insertOriginalEdges().

◆ myTurnaround

template<class E , class V >

_RailEdge* RailEdge< E, V >::myTurnaround

private

Definition at line 270 of file RailEdge.h.

Referenced by RailEdge< E, V >::addVirtualTurns(), RailEdge< E, V >::init(), and RailEdge< E, V >::~RailEdge().

◆ myViaSuccessors

template<class E , class V >

ConstEdgePairVector RailEdge< E, V >::myViaSuccessors

mutableprivate

Definition at line 284 of file RailEdge.h.

Referenced by RailEdge< E, V >::addVirtualTurns(), RailEdge< E, V >::getViaSuccessors(), RailEdge< E, V >::init(), and RailEdge< E, V >::RailEdge().

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

RailEdge.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ _RailEdge

◆ ConstEdgePairVector

Constructor & Destructor Documentation

◆ RailEdge() [1/2]

◆ RailEdge() [2/2]

◆ ~RailEdge()

Member Function Documentation

◆ addVirtualTurns()

◆ getID()

◆ getLength()

◆ getNumericalID()

◆ getOriginal()

◆ getViaSuccessors()

◆ init()

◆ insertOriginalEdges()

◆ isInternal()

◆ isVirtual()

◆ prohibits()

◆ restricts()

◆ update()

Field Documentation

◆ myClassesViaSuccessorMap

◆ myID

◆ myIsVirtual

◆ myMaxLength

◆ myNumericalID

◆ myOriginal

◆ myReplacementEdges

◆ myStartLength

◆ myTurnaround

◆ myViaSuccessors