Inheritance diagram for dsf::mobility::TrafficLight:

Public Member Functions
	TrafficLight (Id id, Delay cycleTime)
	Construct a new TrafficLight object.

	TrafficLight (Id id, Delay cycleTime, geometry::Point point)
	Construct a new TrafficLight object.

	TrafficLight (RoadJunction const &node, Delay const cycleTime, Delay const counter=0)
	Construct a new TrafficLight object.

TrafficLight &	operator++ ()

double	meanGreenTime (bool priorityStreets) const
	Get the mean green time over every cycle.

Delay	cycleTime () const
	Get the traffic light's total cycle time.

void	setCycle (Id const streetId, Direction direction, TrafficLightCycle const &cycle)
	Set the cycle for a street and a direction.

void	setCycles (std::unordered_map< Id, std::unordered_map< Direction, TrafficLightCycle > > cycles)
	Set the traffic light's cycles.

void	setComplementaryCycle (Id const streetId, Id const existingCycle)
	Set the complementary cycle for a street.

void	increasePhases (Delay const phase)
	Increase the phase times of the traffic light cycles.

std::unordered_map< Id, std::unordered_map< Direction, TrafficLightCycle > > const &	cycles () const
	Get the traffic light's cycles.

Delay	counter () const

bool	isDefault () const
	Returns true if all the cycles are set to their default values.

bool	isGreen (Id const streetId, Direction direction) const
	Returns true if the traffic light is green for a street and a direction.

void	resetCycles ()
	Resets all traffic light cycles.

constexpr bool	isTrafficLight () const noexcept

Public Member Functions inherited from dsf::mobility::Intersection
	Intersection (Id id)
	Construct a new Intersection object.

	Intersection (Id id, geometry::Point coords)
	Construct a new Intersection object.

	Intersection (RoadJunction const &node)

	Intersection (Intersection const &)=delete

void	setCapacity (Size capacity) override
	Set the node's capacity.

void	addAgent (double angle, std::unique_ptr< Agent > pAgent)
	Put an agent in the node.

void	addAgent (std::unique_ptr< Agent > pAgent)
	Put an agent in the node.

void	setStreetPriorities (std::set< Id > streetPriorities)
	Set the node streets with priority.

void	addStreetPriority (Id streetId)
	Add a street to the node street priorities.

double	density () const override
	Returns the node's density.

bool	isFull () const override
	Returns true if the node is full.

virtual const std::set< Id > &	streetPriorities () const
	Get the node's street priorities.

std::multimap< int16_t, std::unique_ptr< Agent > > &	agents ()
	Get the node's agent ids.

Size	nAgents () const
	Returns the number of agents currently in the node.

constexpr bool	isIntersection () const noexcept final

Public Member Functions inherited from dsf::mobility::RoadJunction
	RoadJunction (Id id)

	RoadJunction (Id id, geometry::Point coords)

	RoadJunction (RoadJunction const &other)

RoadJunction &	operator= (RoadJunction const &other)

void	setTransportCapacity (double capacity)
	Set the junction's transport capacity.

Size	capacity () const
	Get the junction's capacity.

double	transportCapacity () const
	Get the junction's transport capacity.

virtual constexpr bool	isRoundabout () const noexcept

Public Member Functions inherited from dsf::Node
	Node (Id id)
	Construct a new Node object with capacity 1.

	Node (Id id, geometry::Point point)
	Construct a new Node object with capacity 1.

	Node (Node const &other)

Node &	operator= (Node const &other)

void	setId (Id id) noexcept
	Set the node's id.

void	setGeometry (geometry::Point point) noexcept
	Set the node's geometry.

void	setName (const std::string &name) noexcept
	Set the node's name.

void	addIngoingEdge (Id edgeId)
	Add an ingoing edge to the node.

void	addOutgoingEdge (Id edgeId)
	Add an outgoing edge to the node.

Id	id () const
	Get the node's id.

std::optional< geometry::Point > const &	geometry () const noexcept
	Get the node's geometry.

std::string const &	name () const noexcept
	Get the node's name.

std::vector< Id > const &	ingoingEdges () const noexcept

std::vector< Id > const &	outgoingEdges () const noexcept

virtual bool	isStation () const noexcept

Static Public Member Functions
static void	setAllowFreeTurns (bool allow)

Additional Inherited Members
Protected Attributes inherited from dsf::mobility::Intersection
std::multimap< int16_t, std::unique_ptr< Agent > >	m_agents

std::set< Id >	m_streetPriorities

Protected Attributes inherited from dsf::Node
Id	m_id

std::optional< geometry::Point >	m_geometry

std::string	m_name

std::vector< Id >	m_ingoingEdges

std::vector< Id >	m_outgoingEdges

Constructor & Destructor Documentation

◆ TrafficLight() [1/3]

dsf::mobility::TrafficLight::TrafficLight	(	Id	id,
		Delay	cycleTime )

inline

Construct a new TrafficLight object.

Parameters

id	The node's id
cycleTime	The node's cycle time

◆ TrafficLight() [2/3]

dsf::mobility::TrafficLight::TrafficLight	(	Id	id,
		Delay	cycleTime,
		geometry::Point	point )

inline

Construct a new TrafficLight object.

Parameters

id	The node's id
cycleTime	The node's cycle time
point	A dsf::geometry::Point containing the node's coordinates

◆ TrafficLight() [3/3]

dsf::mobility::TrafficLight::TrafficLight	(	RoadJunction const &	node,
		Delay const	cycleTime,
		Delay const	counter = 0 )

inline

Construct a new TrafficLight object.

Parameters

node	A RoadJunction object representing the traffic light
cycleTime	The node's cycle time
counter	The node's counter

Member Function Documentation

◆ cycles()

std::unordered_map< Id, std::unordered_map< Direction, TrafficLightCycle > > const & dsf::mobility::TrafficLight::cycles ( ) const

inline

Get the traffic light's cycles.

Returns: std::unordered_map<Id, std::unordered_map<Direction, TrafficLightCycle>> const& The traffic light's cycles

◆ cycleTime()

Delay dsf::mobility::TrafficLight::cycleTime ( ) const

inline

Get the traffic light's total cycle time.

Returns: Delay The traffic light's cycle time

◆ increasePhases()

void dsf::mobility::TrafficLight::increasePhases ( Delay const phase )

Increase the phase times of the traffic light cycles.

Parameters

phase Delay, the amount of time to increase the phase for each cycle

◆ isGreen()

bool dsf::mobility::TrafficLight::isGreen	(	Id const	streetId,
		Direction	direction ) const

Returns true if the traffic light is green for a street and a direction.

Parameters

streetId	Id, the street's id
direction	Direction, the direction

Returns: true if the traffic light is green for the street and direction

◆ isTrafficLight()

bool dsf::mobility::TrafficLight::isTrafficLight ( ) const

inlineconstexprvirtualnoexcept

Reimplemented from dsf::mobility::RoadJunction.

◆ meanGreenTime()

double dsf::mobility::TrafficLight::meanGreenTime ( bool priorityStreets ) const

Get the mean green time over every cycle.

Parameters

priorityStreets bool, if true, only the priority streets are considered; if false, only the non-priority streets are considered

Returns: double The mean green time

The mean green time is the mean green time of all the cycles for the priority streets if priorityStreets is true, or for the non-priority streets if priorityStreets is false.

◆ resetCycles()

void dsf::mobility::TrafficLight::resetCycles ( )

Resets all traffic light cycles.

For more info, see TrafficLightCycle::reset()

◆ setComplementaryCycle()

void dsf::mobility::TrafficLight::setComplementaryCycle	(	Id const	streetId,
		Id const	existingCycle )

Set the complementary cycle for a street.

Parameters

streetId	Id, The street's id
existingCycle	Id, The street's id associated with the existing cycle

Exceptions

std::invalid_argument	if the street id does not exist
std::invalid_argument	if the cycle does not exist

The complementary cycle is a cycle that has as green time the total cycle time minus the green time of the existing cycle. The phase is the total cycle time minus the green time of the existing cycle, plus the phase of the existing cycle.

◆ setCycle()

void dsf::mobility::TrafficLight::setCycle	(	Id const	streetId,
		Direction	direction,
		TrafficLightCycle const &	cycle )

Set the cycle for a street and a direction.

Parameters

streetId	The street's id
direction	The direction
cycle	The traffic light cycle

◆ setCycles()

void dsf::mobility::TrafficLight::setCycles ( std::unordered_map< Id, std::unordered_map< Direction, TrafficLightCycle > > cycles )

inline

Set the traffic light's cycles.

Parameters

cycles std::unordered_map<Id, std::unordered_map<Direction, TrafficLightCycle>> The traffic light's cycles

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

src/dsf/mobility/TrafficLight.hpp
src/dsf/mobility/TrafficLight.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ TrafficLight() [1/3]

◆ TrafficLight() [2/3]

◆ TrafficLight() [3/3]

Member Function Documentation

◆ cycles()

◆ cycleTime()

◆ increasePhases()

◆ isGreen()

◆ isTrafficLight()

◆ meanGreenTime()

◆ resetCycles()

◆ setComplementaryCycle()

◆ setCycle()

◆ setCycles()