SUMO - Simulation of Urban MObility
MSTLLogicControl::WAUTSwitchProcedure Class Reference

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

#include <MSTLLogicControl.h>

Inheritance diagram for MSTLLogicControl::WAUTSwitchProcedure:
MSTLLogicControl::WAUTSwitchProcedure_GSP MSTLLogicControl::WAUTSwitchProcedure_JustSwitch MSTLLogicControl::WAUTSwitchProcedure_Stretch

Public Member Functions

virtual bool trySwitch (SUMOTime step)=0
 Determines whether a switch is possible.
 WAUTSwitchProcedure (MSTLLogicControl &control, WAUT &waut, MSTrafficLightLogic *from, MSTrafficLightLogic *to, bool synchron)
 Constructor.
virtual ~WAUTSwitchProcedure ()
 Destructor.

Protected Member Functions

SUMOTime getDiffToStartOfPhase (MSTrafficLightLogic &logic, SUMOTime toTime)
 Returns the difference between a given time and the start of the phase.
unsigned int getGSPValue (const MSTrafficLightLogic &logic) const
 Returns the GSP-value.
bool isPosAtGSP (SUMOTime currentTime, const MSTrafficLightLogic &logic)
 Checks, whether the position of a signal programm is at the GSP ("GuenstigerUmschaltPunkt")
void switchToPos (SUMOTime simStep, MSTrafficLightLogic &logic, SUMOTime toTime)
 switches the given logic directly to the given position

Protected Attributes

MSTLLogicControlmyControl
 The control the logic belongs to.
MSTrafficLightLogicmyFrom
 The current program of the tls to switch.
bool mySwitchSynchron
 Information whether to switch synchron (?)
MSTrafficLightLogicmyTo
 The program to switch the tls to.
WAUTmyWAUT
 The WAUT responsible for switching.

Private Member Functions

WAUTSwitchProcedureoperator= (const WAUTSwitchProcedure &)
 Invalidated assignment operator.
 WAUTSwitchProcedure (const WAUTSwitchProcedure &)
 Invalidated copy constructor.

Detailed Description

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

Definition at line 504 of file MSTLLogicControl.h.


Constructor & Destructor Documentation

Constructor.

Parameters:
[in]controlThe responsible tls control
[in]wautThe WAUT to switch
[in]fromThe original tls program
[in]toThe destination tls program
[in]synchronWhether the switch shall be done in synchronuous mode

Definition at line 513 of file MSTLLogicControl.h.

Destructor.

Definition at line 520 of file MSTLLogicControl.h.

Invalidated copy constructor.


Member Function Documentation

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

Parameters:
[in]logicThe logic to consider
[in]toTimeThe time to ask for
Returns:
How much time elapsed between the last pahse start and the given time

Definition at line 241 of file MSTLLogicControl.cpp.

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

unsigned int MSTLLogicControl::WAUTSwitchProcedure::getGSPValue ( const MSTrafficLightLogic logic) const [protected]

Returns the GSP-value.

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

Parameters:
[in]logicThe logic to retrieve the GSP from
Returns:
The GSP value; 0 if not given.
See also:
MSTrafficLightLogic::getParameterValue

Definition at line 222 of file MSTLLogicControl.cpp.

References MSTrafficLightLogic::getParameterValue().

bool MSTLLogicControl::WAUTSwitchProcedure::isPosAtGSP ( SUMOTime  currentTime,
const MSTrafficLightLogic logic 
) [protected]

Checks, whether the position of a signal programm is at the GSP ("GuenstigerUmschaltPunkt")

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]currentTimeThe current time step
[in]logicThe logic for which this should be examined
Returns:
Whether the current step is the GSP
See also:
getGSPValue

Definition at line 232 of file MSTLLogicControl.cpp.

References MSPhaseDefinition::duration, MSTrafficLightLogic::getCurrentPhaseDef(), MSTrafficLightLogic::getCurrentPhaseIndex(), MSTrafficLightLogic::getDefaultCycleTime(), MSTrafficLightLogic::getNextSwitchTime(), MSTrafficLightLogic::getOffsetFromIndex(), and TIME2STEPS.

WAUTSwitchProcedure& MSTLLogicControl::WAUTSwitchProcedure::operator= ( const WAUTSwitchProcedure ) [private]

Invalidated assignment operator.

void MSTLLogicControl::WAUTSwitchProcedure::switchToPos ( SUMOTime  simStep,
MSTrafficLightLogic logic,
SUMOTime  toTime 
) [protected]

switches the given logic directly to the given position

Parameters:
[in]simStepThe current simulation time
[in]logicThe logic to switch
[in]toTimeThe time offset within the logic's phases to switch to

Definition at line 250 of file MSTLLogicControl.cpp.

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

Determines whether a switch is possible.

Parameters:
[in]stepThe current simulation step
Returns:
If a switch shall be done, this method should return true.

Implemented in MSTLLogicControl::WAUTSwitchProcedure_Stretch, MSTLLogicControl::WAUTSwitchProcedure_GSP, and MSTLLogicControl::WAUTSwitchProcedure_JustSwitch.

Referenced by MSTLLogicControl::check2Switch().


Field Documentation

The control the logic belongs to.

Definition at line 584 of file MSTLLogicControl.h.

The current program of the tls to switch.

Definition at line 572 of file MSTLLogicControl.h.

Information whether to switch synchron (?)

Definition at line 578 of file MSTLLogicControl.h.

The program to switch the tls to.

Definition at line 575 of file MSTLLogicControl.h.

The WAUT responsible for switching.

Definition at line 581 of file MSTLLogicControl.h.


The documentation for this class was generated from the following files:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines