Eclipse SUMO - Simulation of Urban MObility
MSTrafficLightLogic::SwitchCommand Class Reference

Class realising the switch between the traffic light phases. More...

#include <MSTrafficLightLogic.h>

Inheritance diagram for MSTrafficLightLogic::SwitchCommand:
[legend]
Collaboration diagram for MSTrafficLightLogic::SwitchCommand:
[legend]

Public Member Functions

void deschedule (MSTrafficLightLogic *tlLogic)
 Marks this swicth as invalid (if the phase duration has changed, f.e.) More...
 
SUMOTime execute (SUMOTime currentTime)
 Executes the regarded junction's "trySwitch"- method. More...
 
SUMOTime getNextSwitchTime () const
 Returns the assumed next switch time. More...
 
SUMOTime shiftTime (SUMOTime currentTime, SUMOTime execTime, SUMOTime newTime)
 Reschedule or deschedule the command when quick-loading state. More...
 
 SwitchCommand (MSTLLogicControl &tlcontrol, MSTrafficLightLogic *tlLogic, SUMOTime nextSwitch)
 Constructor. More...
 
 ~SwitchCommand ()
 Destructor. More...
 

Data Fields

int priority = 0
 

Private Member Functions

SwitchCommandoperator= (const SwitchCommand &)
 Invalidated assignment operator. More...
 
 SwitchCommand (const SwitchCommand &)
 Invalidated copy constructor. More...
 

Private Attributes

bool myAmValid
 Information whether this switch command is still valid. More...
 
SUMOTime myAssumedNextSwitch
 Assumed switch time (may change in case of adaptive traffic lights) More...
 
MSTLLogicControlmyTLControl
 The responsible traffic lights control. More...
 
MSTrafficLightLogicmyTLLogic
 The logic to be executed on a switch. More...
 

Detailed Description

Class realising the switch between the traffic light phases.

Definition at line 418 of file MSTrafficLightLogic.h.

Constructor & Destructor Documentation

◆ SwitchCommand() [1/2]

MSTrafficLightLogic::SwitchCommand::SwitchCommand ( MSTLLogicControl tlcontrol,
MSTrafficLightLogic tlLogic,
SUMOTime  nextSwitch 
)

Constructor.

Parameters
[in]tlcontrolThe responsible traffic lights control
[in]tlLogicThe controlled tls logic
[in]durationDuration till next switch

Definition at line 52 of file MSTrafficLightLogic.cpp.

References Command::priority.

◆ ~SwitchCommand()

MSTrafficLightLogic::SwitchCommand::~SwitchCommand ( )

Destructor.

Definition at line 61 of file MSTrafficLightLogic.cpp.

◆ SwitchCommand() [2/2]

MSTrafficLightLogic::SwitchCommand::SwitchCommand ( const SwitchCommand )
private

Invalidated copy constructor.

Member Function Documentation

◆ deschedule()

void MSTrafficLightLogic::SwitchCommand::deschedule ( MSTrafficLightLogic tlLogic)

Marks this swicth as invalid (if the phase duration has changed, f.e.)

Parameters
[in]tlLogicThe controlled tls logic

Definition at line 94 of file MSTrafficLightLogic.cpp.

Referenced by MSActuatedTrafficLightLogic::changeStepAndDuration(), MSSimpleTrafficLightLogic::changeStepAndDuration(), MSActuatedTrafficLightLogic::loadState(), and MSSimpleTrafficLightLogic::MSSimpleTrafficLightLogic().

Here is the caller graph for this function:

◆ execute()

SUMOTime MSTrafficLightLogic::SwitchCommand::execute ( SUMOTime  currentTime)
virtual

Executes the regarded junction's "trySwitch"- method.

Parameters
[in]currentTimeThe current simulation time
Returns
The time after which the command shall be executed again (the time of next switch)

Implements Command.

Definition at line 66 of file MSTrafficLightLogic.cpp.

References MSTLLogicControl::TLSLogicVariants::executeOnSwitchActions().

◆ getNextSwitchTime()

SUMOTime MSTrafficLightLogic::SwitchCommand::getNextSwitchTime ( ) const
inline

Returns the assumed next switch time.

Returns
The assumed next switch time

Definition at line 448 of file MSTrafficLightLogic.h.

References myAssumedNextSwitch.

Referenced by MSTrafficLightLogic::getNextSwitchTime().

Here is the caller graph for this function:

◆ operator=()

SwitchCommand& MSTrafficLightLogic::SwitchCommand::operator= ( const SwitchCommand )
private

Invalidated assignment operator.

◆ shiftTime()

SUMOTime MSTrafficLightLogic::SwitchCommand::shiftTime ( SUMOTime  currentTime,
SUMOTime  execTime,
SUMOTime  newTime 
)
virtual

Reschedule or deschedule the command when quick-loading state.

The implementations should return -1 if the command shall not be re-scheduled, or a value >= 0 that describe the new time at which the command shall be executed again.

Parameters
[in]currentTimeThe current simulation time
[in]execTimeThe time at which the command would have been executed
[in]newTimeThe simulation time at which the simulation is restarted
Returns
The time at which the command shall be executed again

Reimplemented from Command.

Definition at line 103 of file MSTrafficLightLogic.cpp.

References DELTA_T, and UNUSED_PARAMETER.

Field Documentation

◆ myAmValid

bool MSTrafficLightLogic::SwitchCommand::myAmValid
private

Information whether this switch command is still valid.

Definition at line 476 of file MSTrafficLightLogic.h.

◆ myAssumedNextSwitch

SUMOTime MSTrafficLightLogic::SwitchCommand::myAssumedNextSwitch
private

Assumed switch time (may change in case of adaptive traffic lights)

Definition at line 473 of file MSTrafficLightLogic.h.

Referenced by getNextSwitchTime().

◆ myTLControl

MSTLLogicControl& MSTrafficLightLogic::SwitchCommand::myTLControl
private

The responsible traffic lights control.

Definition at line 467 of file MSTrafficLightLogic.h.

◆ myTLLogic

MSTrafficLightLogic* MSTrafficLightLogic::SwitchCommand::myTLLogic
private

The logic to be executed on a switch.

Definition at line 470 of file MSTrafficLightLogic.h.

◆ priority

int Command::priority = 0
inherited

Definition at line 87 of file Command.h.

Referenced by SwitchCommand().


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