The Intersection class represents a node in the network. More...

#include <Intersection.hpp>

Inheritance diagram for dsf::mobility::Intersection:

Public Member Functions
	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	isTrafficLight () const noexcept

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

Protected Attributes
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

Detailed Description

The Intersection class represents a node in the network.

Template Parameters

Id	The type of the node's id. It must be an unsigned integral type.

Constructor & Destructor Documentation

◆ Intersection() [1/2]

dsf::mobility::Intersection::Intersection ( Id id )

inlineexplicit

Construct a new Intersection object.

Parameters

id	The node's id

◆ Intersection() [2/2]

dsf::mobility::Intersection::Intersection	(	Id	id,
		geometry::Point	coords )

inline

Construct a new Intersection object.

Parameters

id	The node's id
coords	A dsf::geometry::Point containing the node's coordinates

Member Function Documentation

◆ addAgent() [1/2]

void dsf::mobility::Intersection::addAgent	(	double	angle,
		std::unique_ptr< Agent >	pAgent )

Put an agent in the node.

Parameters

agent A std::pair containing the agent's angle difference and id

The agent's angle difference is used to order the agents in the node. The agent with the smallest angle difference is the first one to be removed from the node.

Exceptions

std::runtime_error if the node is full

◆ addAgent() [2/2]

void dsf::mobility::Intersection::addAgent ( std::unique_ptr< Agent > pAgent )

Put an agent in the node.

Parameters

agentId The agent's id

The agent's angle difference is used to order the agents in the node. The agent with the smallest angle difference is the first one to be removed from the node.

Exceptions

std::runtime_error if the node is full

◆ addStreetPriority()

void dsf::mobility::Intersection::addStreetPriority ( Id streetId )

inline

Add a street to the node street priorities.

Parameters

streetId The street's id

◆ agents()

std::multimap< int16_t, std::unique_ptr< Agent > > & dsf::mobility::Intersection::agents ( )

inline

Get the node's agent ids.

Returns: std::set<Id> A std::set containing the node's agent ids

◆ density()

double dsf::mobility::Intersection::density ( ) const

inlineoverridevirtual

Returns the node's density.

Returns: double The node's density

Reimplemented from dsf::mobility::RoadJunction.

◆ isFull()

bool dsf::mobility::Intersection::isFull ( ) const

inlineoverridevirtual

Returns true if the node is full.

Returns: bool True if the node is full

Reimplemented from dsf::mobility::RoadJunction.

◆ isIntersection()

bool dsf::mobility::Intersection::isIntersection ( ) const

inlineconstexprfinalvirtualnoexcept

Reimplemented from dsf::mobility::RoadJunction.

◆ nAgents()

Size dsf::mobility::Intersection::nAgents ( ) const

inline

Returns the number of agents currently in the node.

Returns: Size The number of agents currently in the node

◆ setCapacity()

void dsf::mobility::Intersection::setCapacity ( Size capacity )

overridevirtual

Set the node's capacity.

Parameters

capacity The node's capacity

Exceptions

std::runtime_error if the capacity is smaller than the current queue size

Reimplemented from dsf::mobility::RoadJunction.

◆ setStreetPriorities()

void dsf::mobility::Intersection::setStreetPriorities ( std::set< Id > streetPriorities )

inline

Set the node streets with priority.

Parameters

streetPriorities A std::set containing the node's street priorities

◆ streetPriorities()

virtual const std::set< Id > & dsf::mobility::Intersection::streetPriorities ( ) const

inlinevirtual

Get the node's street priorities.

This function returns a std::set containing the node's street priorities. If a street has priority, it means that the agents that are on that street have priority over the agents that are on the other streets.

Returns: std::set<Id> A std::set containing the node's street priorities

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

src/dsf/mobility/Intersection.hpp
src/dsf/mobility/Intersection.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Intersection() [1/2]

◆ Intersection() [2/2]

Member Function Documentation

◆ addAgent() [1/2]

◆ addAgent() [2/2]

◆ addStreetPriority()

◆ agents()

◆ density()

◆ isFull()

◆ isIntersection()

◆ nAgents()

◆ setCapacity()

◆ setStreetPriorities()

◆ streetPriorities()