dsf::TrafficLight Class Reference

Inheritance diagram for dsf::TrafficLight:

Public Member Functions
	TrafficLight (Id id, Delay cycleTime)
	Construct a new TrafficLight object.
	TrafficLight (Id id, Delay cycleTime, std::pair< double, double > coords)
	TrafficLight (RoadJunction const &node, Delay const cycleTime, Delay const counter=0)
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	moveCycle (Id const oldStreetId, Id const newStreetId)
	Move a cycle from one street to another.
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.
bool	isTrafficLight () const noexcept
Public Member Functions inherited from dsf::Intersection
	Intersection (Id id)
	Construct a new Intersection object.
	Intersection (Id id, std::pair< double, double > 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	agentCounter ()
	Returns the number of agents that have passed through the node.
bool	isIntersection () const noexcept final
Public Member Functions inherited from dsf::RoadJunction
	RoadJunction (Id id)
	RoadJunction (Id id, std::pair< double, double > 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 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, std::pair< double, double > coords)
	Construct a new Node object with capacity 1.
	Node (Node const &other)
Node &	operator= (Node const &other)
void	setId (Id id)
	Set the node's id.
void	setCoords (std::pair< double, double > coords)
	Set the node's coordinates.
void	setName (const std::string &name)
	Set the node's name.
void	setStrId (const std::string &strId)
Id	id () const
	Get the node's id.
std::optional< std::pair< double, double > > const &	coords () const
	Get the node's coordinates.
std::string const &	name () const noexcept
	Get the node's name.
std::optional< std::string > const &	strId () const noexcept
virtual bool	isStation () const noexcept

Static Public Member Functions
static void	setAllowFreeTurns (bool allow)

Additional Inherited Members
Protected Attributes inherited from dsf::Intersection
std::multimap< int16_t, std::unique_ptr< Agent > >	m_agents
std::set< Id >	m_streetPriorities
Size	m_agentCounter
Protected Attributes inherited from dsf::Node
Id	m_id
std::optional< std::pair< double, double > >	m_coords
std::string	m_name
std::optional< std::string >	m_strId

Constructor & Destructor Documentation

TrafficLight()

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

inline

Construct a new TrafficLight object.

Parameters

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

Member Function Documentation

cycles()

std::unordered_map< Id, std::unordered_map< Direction, TrafficLightCycle > > const & dsf::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::TrafficLight::cycleTime ( ) const

inline

Get the traffic light's total cycle time.

Returns

Delay The traffic light's cycle time

increasePhases()

void dsf::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::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::TrafficLight::isTrafficLight ( ) const

inlinevirtualnoexcept

Reimplemented from dsf::RoadJunction.

meanGreenTime()

double dsf::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.

moveCycle()

void dsf::TrafficLight::moveCycle	(	Id const	oldStreetId,
		Id const	newStreetId )

Move a cycle from one street to another.

Parameters

oldStreetId	Id, the old street id
newStreetId	Id, the new street id

resetCycles()

void dsf::TrafficLight::resetCycles

(

)

Resets all traffic light cycles.

For more info, see TrafficLightCycle::reset()

setComplementaryCycle()

void dsf::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::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::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 file:

• src/dsf/headers/TrafficLight.hpp