A class that stores and controls tls and switching of their programs. More...

#include <MSTLLogicControl.h>

Data Structures
class	OnSwitchAction
	Base class for things to execute if a tls switches to a new phase. More...

class	SwitchInitCommand
	This event-class is used to initialise a WAUT switch at a certain time. More...

class	TLSLogicVariants
	Storage for all programs of a single tls. More...

struct	WAUT
	A WAUT definition. More...

struct	WAUTJunction
	Storage for a junction assigned to a WAUT. More...

struct	WAUTSwitch
	Storage for a WAUTs switch point. More...

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

class	WAUTSwitchProcedure_GSP
	This class switches using the GSP algorithm. More...

class	WAUTSwitchProcedure_JustSwitch
	This class simply switches to the next program. More...

class	WAUTSwitchProcedure_Stretch
	This class switches using the Stretch algorithm. More...

struct	WAUTSwitchProcess
	An initialised switch process. More...

Public Member Functions
bool	add (const std::string &id, const std::string &programID, MSTrafficLightLogic *logic, bool newDefault=true)
	Adds a tls program to the container.

void	check2Switch (SUMOTime step)
	Checks whether any WAUT is trying to switch a tls into another program.

void	clearState (SUMOTime time, bool quickReload=false)
	Clear all tls states before quick-loading state.

bool	closeNetworkReading ()
	Lets MSTLLogicControl know that the network has been loaded.

TLSLogicVariants &	get (const std::string &id) const
	Returns the variants of a named tls.

MSTrafficLightLogic *	get (const std::string &id, const std::string &programID) const
	Returns a single program (variant) defined by the tls id and the program programID.

MSTrafficLightLogic *	getActive (const std::string &id) const
	Returns the active program of a named tls.

std::vector< MSTrafficLightLogic * >	getAllLogics () const
	Returns a vector which contains all logics.

std::vector< std::string >	getAllTLIds () const

std::pair< SUMOTime, MSPhaseDefinition >	getPhaseDef (const std::string &tlid) const
	return the complete phase definition for a named traffic lights logic

SUMOTime	initWautSwitch (SwitchInitCommand &cmd)
	Initialises switching a WAUT.

bool	isActive (const MSTrafficLightLogic *tl) const
	Returns whether the given tls program is the currently active for his tls.

bool	knows (const std::string &id) const
	Returns the information whether the named tls is stored.

	MSTLLogicControl ()
	Constructor.

void	saveState (OutputDevice &out)
	Saves the current tls states into the given stream.

void	setTrafficLightSignals (SUMOTime t) const
	Lets all running (current) tls programs apply their current signal states to links they control.

void	switchOffAll ()
	switch all logic variants to 'off'

void	switchTo (const std::string &id, const std::string &programID)
	Switches the named (id) tls to the named (programID) program.

	~MSTLLogicControl ()
	Destructor.

WAUT definition methods
void	addWAUT (SUMOTime refTime, const std::string &id, const std::string &startProg, SUMOTime period)
	Adds a WAUT definition.

void	addWAUTSwitch (const std::string &wautid, SUMOTime when, const std::string &to)
	Adds a WAUT switch step to a previously built WAUT.

void	addWAUTJunction (const std::string &wautid, const std::string &tls, const std::string &proc, bool synchron)
	Adds a tls to the list of tls to be switched by the named WAUT.

void	closeWAUT (const std::string &wautid)
	Closes loading of a WAUT.

Protected Attributes
std::vector< WAUTSwitchProcess >	myCurrentlySwitched
	A list of currently running switching procedures.

std::map< std::string, TLSLogicVariants * >	myLogics
	A map from ids to the corresponding variants.

bool	myNetWasLoaded
	Information whether the net was completely loaded.

std::map< std::string, WAUT * >	myWAUTs
	A map of ids to corresponding WAUTs.

Private Member Functions
	MSTLLogicControl (const MSTLLogicControl &)
	Invalidated copy constructor.

MSTLLogicControl &	operator= (const MSTLLogicControl &)
	Invalidated assignment operator.

Detailed Description

A class that stores and controls tls and switching of their programs.

This class holds all traffic light logics (programs) and their variants during the simulation. In addition, the schedule for switching between different tls programs are also stored.

When a WAUT is forced to switch, for each TLS, a switching procedure derived from WAUTSwitchProcedure is initialised and is asked repeatedly whether a switch could be done until it returns true.

Definition at line 59 of file MSTLLogicControl.h.

Constructor & Destructor Documentation

◆ MSTLLogicControl() [1/2]

MSTLLogicControl::MSTLLogicControl ( )

Constructor.

Definition at line 520 of file MSTLLogicControl.cpp.

◆ ~MSTLLogicControl()

MSTLLogicControl::~MSTLLogicControl ( )

Destructor.

Definition at line 524 of file MSTLLogicControl.cpp.

References myLogics, and myWAUTs.

◆ MSTLLogicControl() [2/2]

MSTLLogicControl::MSTLLogicControl ( const MSTLLogicControl & )

private

Invalidated copy constructor.

Member Function Documentation

◆ add()

bool MSTLLogicControl::add	(	const std::string &	id,
		const std::string &	programID,
		MSTrafficLightLogic *	logic,
		bool	newDefault = `true`
	)

Adds a tls program to the container.

If a tls with the given id is not yet known, a TLSLogicVariants structure is built for this tls and added to the internal container and the tls program is used as the new default.

If the tls to add is loaded from an additional file (indicated by myNetWasLoaded, see closeNetworkReading), links from previously loaded tls are adapted to the logic. This may throw a ProcessError in the case no tls program was loaded for this tls before (was not defined in the network). In case of an error the logic gets deleted.

The parameter newDefault defines whether this program will be used as the new default program of this tls. This means that an existing tls program for this tls is replaced within the according TLSLogicVariants structure.

Parameters

[in]	id	The id of the tls (program) to add
[in]	programID	The program id of the tls (program) to add
[in]	logic	The tls logic to insert

Exceptions

ProcessError In the case an additional tls program is loaded and no one for the tls existed in the network

Returns: true if the tls program could be added, false otherwise

Definition at line 586 of file MSTLLogicControl.cpp.

References MSTLLogicControl::TLSLogicVariants::addLogic(), myLogics, and myNetWasLoaded.

◆ addWAUT()

void MSTLLogicControl::addWAUT	(	SUMOTime	refTime,
		const std::string &	id,
		const std::string &	startProg,
		SUMOTime	period
	)

Adds a WAUT definition.

Throws an InvalidArgument if the given id is already in use.

Parameters

[in]	refTime	The reference time of the WAUT
[in]	id	The ID of the WAUT
[in]	startProg	The begin program of the WAUT
[in]	period	The period with which to repeat the switches

Exceptions

InvalidArgument If the id is already used by another WAUT

Definition at line 650 of file MSTLLogicControl.cpp.

References MSTLLogicControl::WAUT::id, myWAUTs, MSTLLogicControl::WAUT::period, MSTLLogicControl::WAUT::refTime, and MSTLLogicControl::WAUT::startProg.

Referenced by NLHandler::openWAUT().

Here is the caller graph for this function:

◆ addWAUTJunction()

void MSTLLogicControl::addWAUTJunction	(	const std::string &	wautid,
		const std::string &	tls,
		const std::string &	proc,
		bool	synchron
	)

Adds a tls to the list of tls to be switched by the named WAUT.

Passes the values directly to the used tls control. This throws an InvalidArgument if the given WAUT id or the given junction id is not known.

Parameters

[in]	wautid	The ID of the WAUT
[in]	tls	The id of the tls to be switched
[in]	proc	The switching procedure to use
[in]	synchron	Whether the switching shall be done in synchron mode

Exceptions

InvalidArgument	If the named WAUT or the named tls are not known
ProcessError	If the initial switch fails

Definition at line 687 of file MSTLLogicControl.cpp.

References MSNet::getCurrentTimeStep(), MSNet::getInstance(), MSTLLogicControl::WAUTJunction::junction, myLogics, myWAUTs, MSTLLogicControl::WAUTJunction::procedure, switchTo(), and MSTLLogicControl::WAUTJunction::synchron.

Referenced by NLHandler::addWAUTJunction().

Here is the caller graph for this function:

◆ addWAUTSwitch()

void MSTLLogicControl::addWAUTSwitch	(	const std::string &	wautid,
		SUMOTime	when,
		const std::string &	to
	)

Adds a WAUT switch step to a previously built WAUT.

Throws an InvalidArgument if the given WAUT id is not known.

Parameters

[in]	wautid	The ID of the WAUT
[in]	when	The switch procedure begin
[in]	to	The program the WAUT shall start to switch to at the given time

Exceptions

InvalidArgument If the named WAUT is not known

Definition at line 667 of file MSTLLogicControl.cpp.

References myWAUTs, MSTLLogicControl::WAUT::period, MSTLLogicControl::WAUT::refTime, MSTLLogicControl::WAUTSwitch::to, and MSTLLogicControl::WAUTSwitch::when.

Referenced by NLHandler::addWAUTSwitch().

Here is the caller graph for this function:

◆ check2Switch()

void MSTLLogicControl::check2Switch ( SUMOTime step )

Checks whether any WAUT is trying to switch a tls into another program.

Called from MSNet::simulationStep

Definition at line 802 of file MSTLLogicControl.cpp.

References getActive(), Named::getID(), MSTrafficLightLogic::getProgramID(), myCurrentlySwitched, MSTLLogicControl::WAUTSwitchProcess::proc, switchTo(), MSTLLogicControl::WAUTSwitchProcess::to, TRACI_PROGRAM, and MSTLLogicControl::WAUTSwitchProcedure::trySwitch().

Referenced by MSNet::simulationStep().

Here is the caller graph for this function:

◆ clearState()

void MSTLLogicControl::clearState	(	SUMOTime	time,
		bool	quickReload = `false`
	)

Clear all tls states before quick-loading state.

Definition at line 845 of file MSTLLogicControl.cpp.

References MSRailSignalConstraint::clearState(), myLogics, OFF, RAIL_CROSSING, and RAIL_SIGNAL.

Referenced by MSNet::clearState().

Here is the caller graph for this function:

◆ closeNetworkReading()

bool MSTLLogicControl::closeNetworkReading ( )

Lets MSTLLogicControl know that the network has been loaded.

This method must be called after the network (including the initial tls definitions) was loaded.

The originally loaded traffic lights are also verified herein by calling TLSLogicVariants::checkOriginalTLS, first.

The MSTLLogicControl is informed in order to know that link information is known for the tls programs loaded afterwards so that it may be adapted from the previously loaded tls (a net may only contain one program per tls).

The states of the links controlled by tls are saved for their potential later usage (if the tls is switched to off-mode).

Returns: Whether the traffic lights could be initialised and are correct

Definition at line 606 of file MSTLLogicControl.cpp.

References myLogics, and myNetWasLoaded.

Referenced by NLJunctionControlBuilder::buildTLLogics().

Here is the caller graph for this function:

◆ closeWAUT()

void MSTLLogicControl::closeWAUT ( const std::string & wautid )

Closes loading of a WAUT.

Instantiates the first switch ("SwitchInitCommand") for the WAUT into the network's simulation time step begin event control. Throws an InvalidArgument if the given WAUT id is not known.

Parameters

[in] wautid The ID of the WAUT

Exceptions

InvalidArgument If the named WAUT is not known

See also: SwitchInitCommand

Definition at line 725 of file MSTLLogicControl.cpp.

References MSEventControl::addEvent(), MSNet::getBeginOfTimestepEvents(), MSNet::getCurrentTimeStep(), MSNet::getInstance(), myWAUTs, MSTLLogicControl::WAUT::startProg, and MSTLLogicControl::WAUT::switches.

Referenced by NLHandler::closeWAUT().

Here is the caller graph for this function:

◆ get() [1/2]

MSTLLogicControl::TLSLogicVariants & MSTLLogicControl::get ( const std::string & id ) const

Returns the variants of a named tls.

Parameters

[in] id The id of the tls to get variants of

Returns: The variants of the named tls

Exceptions

InvalidArgument

Definition at line 556 of file MSTLLogicControl.cpp.

References myLogics.

Referenced by NLHandler::addPredecessorConstraint(), NLDiscreteEventBuilder::buildSaveTLSProgramCommand(), NLDiscreteEventBuilder::buildSaveTLStateCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchesCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchStatesCommand(), MSActuatedTrafficLightLogic::changeStepAndDuration(), MSSimpleTrafficLightLogic::changeStepAndDuration(), NLJunctionControlBuilder::closeTrafficLightLogic(), GUITrafficLightLogicWrapper::getPopUpMenu(), NLJunctionControlBuilder::getTLLogic(), libsumo::Helper::getTLS(), NLHandler::initTrafficLightLogic(), MSActuatedTrafficLightLogic::loadState(), MSStateHandler::myStartElement(), NLHandler::myStartElement(), TraCIServerAPI_TrafficLight::processGet(), GUITrafficLightLogicWrapper::switchTLSLogic(), and MSFullExport::writeTLS().

Here is the caller graph for this function:

◆ get() [2/2]

MSTrafficLightLogic * MSTLLogicControl::get	(	const std::string &	id,
		const std::string &	programID
	)		const

Returns a single program (variant) defined by the tls id and the program programID.

Parameters

[in]	id	The id of the tls to get program of
[in]	programID	The program id of the tls program to get

Returns: The defined tls program if existing, 0 otherwise

Definition at line 566 of file MSTLLogicControl.cpp.

References MSTLLogicControl::TLSLogicVariants::getLogic(), and myLogics.

◆ getActive()

MSTrafficLightLogic * MSTLLogicControl::getActive ( const std::string & id ) const

Returns the active program of a named tls.

Parameters

[in] id The id of the tls to get the active program of

Returns: The current program of the defined tls if existing, 0 otherwise

Definition at line 628 of file MSTLLogicControl.cpp.

References myLogics.

Referenced by NLHandler::addDeadlock(), check2Switch(), GUIJunctionWrapper::drawGL(), GUITrafficLightLogicWrapper::getActiveTLLogic(), GUINet::getLinkTLID(), GUINet::getLinkTLIndex(), and getPhaseDef().

Here is the caller graph for this function:

◆ getAllLogics()

std::vector< MSTrafficLightLogic * > MSTLLogicControl::getAllLogics ( ) const

Returns a vector which contains all logics.

All logics are included, active (current) and non-active

Returns: A vector containing all loaded logics

Definition at line 545 of file MSTLLogicControl.cpp.

References myLogics.

Referenced by NLBuilder::build(), GUINet::initGUIStructures(), GUINet::initTLMap(), GUIViewTraffic::onGamingClick(), and MSNet::writeRailSignalBlocks().

Here is the caller graph for this function:

◆ getAllTLIds()

std::vector< std::string > MSTLLogicControl::getAllTLIds ( ) const

Returns the ids of all existing variants-structures, wich are the ids of their contained tls logics (not the logic's programm-ids)

Returns: the list of ids

Definition at line 576 of file MSTLLogicControl.cpp.

References myLogics.

Referenced by NLDiscreteEventBuilder::buildSaveTLSProgramCommand(), NLDiscreteEventBuilder::buildSaveTLStateCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchesCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchStatesCommand(), and MSFullExport::writeTLS().

Here is the caller graph for this function:

◆ getPhaseDef()

std::pair< SUMOTime, MSPhaseDefinition > MSTLLogicControl::getPhaseDef ( const std::string & tlid ) const

return the complete phase definition for a named traffic lights logic

The phase definition will be the current of the currently active program of the named tls.

Parameters

[in] tlid The id of the tls to get the current phases of

Returns: A pair containing the current time and the current phases of the named tls

Definition at line 820 of file MSTLLogicControl.cpp.

References getActive(), MSTrafficLightLogic::getCurrentPhaseDef(), and MSNet::getInstance().

Referenced by GUITrafficLightLogicWrapper::begin2TrackPhases().

Here is the caller graph for this function:

◆ initWautSwitch()

SUMOTime MSTLLogicControl::initWautSwitch ( MSTLLogicControl::SwitchInitCommand & cmd )

Initialises switching a WAUT.

This method is called from a previously built SwitchInitCommand

Parameters

[in] The command which initialises the switch

Returns: The time offset to next call

Definition at line 759 of file MSTLLogicControl.cpp.

References MSTLLogicControl::WAUTSwitchProcess::from, MSTLLogicControl::TLSLogicVariants::getActive(), MSNet::getCurrentTimeStep(), MSTLLogicControl::SwitchInitCommand::getIndex(), MSNet::getInstance(), MSTLLogicControl::TLSLogicVariants::getLogicInstantiatingOff(), MSTLLogicControl::SwitchInitCommand::getWAUTID(), MSTLLogicControl::WAUTSwitchProcess::junction, myCurrentlySwitched, myLogics, myWAUTs, MSTLLogicControl::WAUT::period, MSTLLogicControl::WAUTSwitchProcess::proc, MSTLLogicControl::WAUT::switches, MSTLLogicControl::WAUTSwitch::to, and MSTLLogicControl::WAUTSwitchProcess::to.

Referenced by MSTLLogicControl::SwitchInitCommand::execute().

Here is the caller graph for this function:

◆ isActive()

bool MSTLLogicControl::isActive ( const MSTrafficLightLogic * tl ) const

Returns whether the given tls program is the currently active for his tls.

Parameters

[in] tl The tls to ask for

Returns: Whether the given tl is currently active (or a different program is used)

Definition at line 618 of file MSTLLogicControl.cpp.

References Named::getID(), and myLogics.

Referenced by GUIViewTraffic::onGamingClick().

Here is the caller graph for this function:

◆ knows()

bool MSTLLogicControl::knows ( const std::string & id ) const

Returns the information whether the named tls is stored.

Parameters

[in] id The id of the tls to ask for

Returns: Whether a tls with the given id is known

Definition at line 600 of file MSTLLogicControl.cpp.

References myLogics.

Referenced by NLHandler::addPredecessorConstraint(), NLDiscreteEventBuilder::buildSaveTLSProgramCommand(), NLDiscreteEventBuilder::buildSaveTLStateCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchesCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchStatesCommand(), MSStateHandler::myStartElement(), and NLHandler::myStartElement().

Here is the caller graph for this function:

◆ operator=()

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

private

Invalidated assignment operator.

◆ saveState()

void MSTLLogicControl::saveState ( OutputDevice & out )

Saves the current tls states into the given stream.

Definition at line 835 of file MSTLLogicControl.cpp.

References myLogics, MSDriveWay::saveState(), and MSRailSignalConstraint::saveState().

Referenced by MSStateHandler::saveState().

Here is the caller graph for this function:

◆ setTrafficLightSignals()

void MSTLLogicControl::setTrafficLightSignals ( SUMOTime t ) const

Lets all running (current) tls programs apply their current signal states to links they control.

Parameters

[in] t The current time

See also: MSTrafficLightLogic::setTrafficLightSignals; LinkState; MSLink::setTLState

Definition at line 537 of file MSTLLogicControl.cpp.

References myLogics.

◆ switchOffAll()

void MSTLLogicControl::switchOffAll ( )

switch all logic variants to 'off'

Definition at line 827 of file MSTLLogicControl.cpp.

References myLogics.

Referenced by NLBuilder::build().

Here is the caller graph for this function:

◆ switchTo()

void MSTLLogicControl::switchTo	(	const std::string &	id,
		const std::string &	programID
	)

Switches the named (id) tls to the named (programID) program.

The program with the used programID must be previously added. If the tls itself or the program to switch to is not known, false is returned.

Parameters

[in]	id	The id of the tls to switch to
[in]	programID	The program id of the tls (program) to switch to

Exceptions

ProcessError If either the tls or the program to switch to is not known

Definition at line 638 of file MSTLLogicControl.cpp.

References myLogics.

Referenced by addWAUTJunction(), check2Switch(), MSTLLogicControl::TLSLogicVariants::setStateInstantiatingOnline(), and GUITrafficLightLogicWrapper::switchTLSLogic().

Here is the caller graph for this function:

Field Documentation

◆ myCurrentlySwitched

std::vector<WAUTSwitchProcess> MSTLLogicControl::myCurrentlySwitched

protected

A list of currently running switching procedures.

Definition at line 748 of file MSTLLogicControl.h.

Referenced by check2Switch(), and initWautSwitch().

◆ myLogics

std::map<std::string, TLSLogicVariants*> MSTLLogicControl::myLogics

protected

A map from ids to the corresponding variants.

Definition at line 751 of file MSTLLogicControl.h.

Referenced by add(), addWAUTJunction(), clearState(), closeNetworkReading(), get(), get(), getActive(), getAllLogics(), getAllTLIds(), initWautSwitch(), isActive(), knows(), saveState(), setTrafficLightSignals(), switchOffAll(), switchTo(), and ~MSTLLogicControl().

◆ myNetWasLoaded

bool MSTLLogicControl::myNetWasLoaded

protected

Information whether the net was completely loaded.

Definition at line 754 of file MSTLLogicControl.h.

Referenced by add(), and closeNetworkReading().

◆ myWAUTs

std::map<std::string, WAUT*> MSTLLogicControl::myWAUTs

protected

A map of ids to corresponding WAUTs.

Definition at line 745 of file MSTLLogicControl.h.

Referenced by addWAUT(), addWAUTJunction(), addWAUTSwitch(), closeWAUT(), initWautSwitch(), and ~MSTLLogicControl().

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

Data Structures

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MSTLLogicControl() [1/2]

◆ ~MSTLLogicControl()

◆ MSTLLogicControl() [2/2]

Member Function Documentation

◆ add()

◆ addWAUT()

◆ addWAUTJunction()

◆ addWAUTSwitch()

◆ check2Switch()

◆ clearState()

◆ closeNetworkReading()

◆ closeWAUT()

◆ get() [1/2]

◆ get() [2/2]

◆ getActive()

◆ getAllLogics()

◆ getAllTLIds()

◆ getPhaseDef()

◆ initWautSwitch()

◆ isActive()

◆ knows()

◆ operator=()

◆ saveState()

◆ setTrafficLightSignals()

◆ switchOffAll()

◆ switchTo()

Field Documentation

◆ myCurrentlySwitched

◆ myLogics

◆ myNetWasLoaded

◆ myWAUTs