This is the abstract base class for switching from one tls program to another. More...

#include <MSTLLogicControl.h>

Inheritance diagram for MSTLLogicControl::WAUTSwitchProcedure:

Collaboration diagram for MSTLLogicControl::WAUTSwitchProcedure:

Public Member Functions
virtual bool	trySwitch (SUMOTime step)
	Determines whether a switch is possible. More...

	WAUTSwitchProcedure (MSTLLogicControl &control, WAUT &waut, MSTrafficLightLogic from, MSTrafficLightLogic to, bool synchron)
	Constructor. More...

virtual	~WAUTSwitchProcedure ()
	Destructor. More...

Protected Member Functions
virtual void	adaptLogic (SUMOTime step)
	Changes the destination program's phase to which the tls was switched. More...

SUMOTime	getDiffToStartOfPhase (MSTrafficLightLogic &logic, SUMOTime toTime)
	Returns the difference between a given time and the start of the phase. More...

SUMOTime	getGSPTime (const MSTrafficLightLogic &logic) const
	Returns the GSP-value. More...

bool	isPosAtGSP (SUMOTime currentTime, const MSTrafficLightLogic &logic)
	Checks, whether the position of a signal programm is at the GSP ("Good Switching Point") More...

void	switchToPos (SUMOTime simStep, MSTrafficLightLogic &logic, SUMOTime toTime)
	switches the given logic directly to the given position More...

Protected Attributes
MSTLLogicControl &	myControl
	The control the logic belongs to. More...

MSTrafficLightLogic *	myFrom
	The current program of the tls to switch. More...

bool	mySwitchSynchron
	Information whether to switch synchron (?) More...

MSTrafficLightLogic *	myTo
	The program to switch the tls to. More...

WAUT &	myWAUT
	The WAUT responsible for switching. More...

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

	WAUTSwitchProcedure (const WAUTSwitchProcedure &)
	Invalidated copy constructor. More...

Detailed Description

This is the abstract base class for switching from one tls program to another.

Definition at line 511 of file MSTLLogicControl.h.

Constructor & Destructor Documentation

◆ WAUTSwitchProcedure() [1/2]

MSTLLogicControl::WAUTSwitchProcedure::WAUTSwitchProcedure	(	MSTLLogicControl &	control,
		WAUT &	waut,
		MSTrafficLightLogic *	from,
		MSTrafficLightLogic *	to,
		bool	synchron
	)

inline

Constructor.

Parameters

[in]	control	The responsible tls control
[in]	waut	The WAUT to switch
[in]	from	The original tls program
[in]	to	The destination tls program
[in]	synchron	Whether the switch shall be done in synchronuous mode

Definition at line 520 of file MSTLLogicControl.h.

◆ ~WAUTSwitchProcedure()

virtual MSTLLogicControl::WAUTSwitchProcedure::~WAUTSwitchProcedure ( )

inlinevirtual

Destructor.

Definition at line 527 of file MSTLLogicControl.h.

◆ WAUTSwitchProcedure() [2/2]

MSTLLogicControl::WAUTSwitchProcedure::WAUTSwitchProcedure ( const WAUTSwitchProcedure & )

private

Invalidated copy constructor.

Member Function Documentation

◆ adaptLogic()

virtual void MSTLLogicControl::WAUTSwitchProcedure::adaptLogic ( SUMOTime step )

inlineprotectedvirtual

Changes the destination program's phase to which the tls was switched.

Default does nothing, implemented only in the subclasses.

Parameters

[in] step The current simulation time

Reimplemented in MSTLLogicControl::WAUTSwitchProcedure_Stretch, and MSTLLogicControl::WAUTSwitchProcedure_GSP.

Definition at line 578 of file MSTLLogicControl.h.

References UNUSED_PARAMETER.

◆ getDiffToStartOfPhase()

SUMOTime MSTLLogicControl::WAUTSwitchProcedure::getDiffToStartOfPhase	(	MSTrafficLightLogic &	logic,
		SUMOTime	toTime
	)

protected

Returns the difference between a given time and the start of the phase.

Parameters

[in]	logic	The logic to consider
[in]	toTime	The time to ask for

Returns: How much time elapsed between the last pahse start and the given time

Definition at line 304 of file MSTLLogicControl.cpp.

References MSTrafficLightLogic::getIndexFromOffset(), and MSTrafficLightLogic::getOffsetFromIndex().

◆ getGSPTime()

SUMOTime MSTLLogicControl::WAUTSwitchProcedure::getGSPTime ( const MSTrafficLightLogic & logic ) const

protected

Returns the GSP-value.

The GSP must be given as a logic's parameter ("GSP").

Parameters

[in] logic The logic to retrieve the GSP from

Returns: The GSP value; 0 if not given.

See also: MSTrafficLightLogic::getParameterValue

Definition at line 290 of file MSTLLogicControl.cpp.

References Parameterised::getParameter(), and string2time().

◆ isPosAtGSP()

bool MSTLLogicControl::WAUTSwitchProcedure::isPosAtGSP	(	SUMOTime	currentTime,
		const MSTrafficLightLogic &	logic
	)

protected

Checks, whether the position of a signal programm is at the GSP ("Good Switching Point")

The GSP must be given as a logic's parameter ("GSP"). Not the simulation second, but the phase the GSP lies within is used. If the phase the GSP lies within is the same as the logic's current phase, the result is true.

Parameters

[in]	currentTime	The current time step
[in]	logic	The logic for which this should be examined

Returns: Whether the current step is the GSP

See also: getGSPValue

Definition at line 296 of file MSTLLogicControl.cpp.

References MSTrafficLightLogic::getCurrentPhaseIndex(), MSTrafficLightLogic::getDefaultCycleTime(), MSTrafficLightLogic::getOffsetFromIndex(), and MSTrafficLightLogic::getSpentDuration().

◆ operator=()

WAUTSwitchProcedure& MSTLLogicControl::WAUTSwitchProcedure::operator= ( const WAUTSwitchProcedure & )

private

Invalidated assignment operator.

◆ switchToPos()

void MSTLLogicControl::WAUTSwitchProcedure::switchToPos	(	SUMOTime	simStep,
		MSTrafficLightLogic &	logic,
		SUMOTime	toTime
	)

protected

switches the given logic directly to the given position

Parameters

[in]	simStep	The current simulation time
[in]	logic	The logic to switch
[in]	toTime	The time offset within the logic's phases to switch to

Definition at line 313 of file MSTLLogicControl.cpp.

References MSTrafficLightLogic::changeStepAndDuration(), MSPhaseDefinition::duration, MSTrafficLightLogic::getIndexFromOffset(), and MSTrafficLightLogic::getPhase().

◆ trySwitch()

bool MSTLLogicControl::WAUTSwitchProcedure::trySwitch ( SUMOTime step )

virtual

Determines whether a switch is possible.

Parameters

[in] step The current simulation step

Returns: If a switch shall be done, this method should return true.

Reimplemented in MSTLLogicControl::WAUTSwitchProcedure_JustSwitch.

Definition at line 272 of file MSTLLogicControl.cpp.

Referenced by MSTLLogicControl::check2Switch().

Here is the caller graph for this function:

Field Documentation

◆ myControl

MSTLLogicControl& MSTLLogicControl::WAUTSwitchProcedure::myControl

protected

The control the logic belongs to.

Definition at line 596 of file MSTLLogicControl.h.

◆ myFrom

MSTrafficLightLogic* MSTLLogicControl::WAUTSwitchProcedure::myFrom

protected

The current program of the tls to switch.

Definition at line 584 of file MSTLLogicControl.h.

◆ mySwitchSynchron

bool MSTLLogicControl::WAUTSwitchProcedure::mySwitchSynchron

protected

Information whether to switch synchron (?)

Definition at line 590 of file MSTLLogicControl.h.

◆ myTo

MSTrafficLightLogic* MSTLLogicControl::WAUTSwitchProcedure::myTo

protected

The program to switch the tls to.

Definition at line 587 of file MSTLLogicControl.h.

Referenced by MSTLLogicControl::WAUTSwitchProcedure_Stretch::WAUTSwitchProcedure_Stretch().

◆ myWAUT

WAUT& MSTLLogicControl::WAUTSwitchProcedure::myWAUT

protected

The WAUT responsible for switching.

Definition at line 593 of file MSTLLogicControl.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WAUTSwitchProcedure() [1/2]

◆ ~WAUTSwitchProcedure()

◆ WAUTSwitchProcedure() [2/2]

Member Function Documentation

◆ adaptLogic()

◆ getDiffToStartOfPhase()

◆ getGSPTime()

◆ isPosAtGSP()

◆ operator=()

◆ switchToPos()

◆ trySwitch()

Field Documentation

◆ myControl

◆ myFrom

◆ mySwitchSynchron

◆ myTo

◆ myWAUT