Inheritance diagram for dsf::mobility::Road:

Public Member Functions
	Road (Id id, std::pair< Id, Id > nodePair, double length=m_meanVehicleLength, double maxSpeed=13.8888888889, int nLanes=1, std::string name=std::string(), geometry::PolyLine geometry={}, std::optional< int > capacity=std::nullopt, double transportCapacity=1.)
	Construct a new Road object.

void	setMaxSpeed (double speed)
	Set the maximum speed, in meters per second (default is 50 km/h)

void	setCapacity (int capacity)
	Set the capacity, in number of agents.

void	setTransportCapacity (double transportCapacity)
	Set the transport capacity, in number of agents.

void	setPriority (int priority)
	Set the road's priority.

void	addForbiddenTurn (Id roadId)
	Add a road id to the forbidden turns.

void	setForbiddenTurns (std::set< Id > const &forbiddenTurns)
	Replace the road's forbidden turns with the given set.

double	length () const
	Get the length, in meters.

double	maxSpeed () const
	Get the maximum speed, in meters per second.

int	nLanes () const
	Get the number of lanes.

int	capacity () const
	Get the road's capacity, in number of agents.

double	transportCapacity () const
	Get the road's transport capacity, in number of agents.

std::string	name () const
	Get the name.

int	priority () const
	Get the priority.

std::set< Id > const &	forbiddenTurns () const
	Get the road's forbidden turns.

Direction	turnDirection (double const &previousStreetAngle) const
	Get the road's turn direction given the previous road angle.

virtual int	nAgents () const =0

virtual int	nMovingAgents () const =0

virtual double	nExitingAgents (Direction direction, bool normalizeOnNLanes) const =0

virtual double	density (bool normalized=false) const =0

Public Member Functions inherited from dsf::Edge
	Edge (Id id, std::pair< Id, Id > nodePair, geometry::PolyLine geometry={})
	Construct a new Edge object.

	Edge (Edge &&)=default

	Edge (const Edge &)=delete

void	resetId (Id newId)

void	setGeometry (geometry::PolyLine geometry)

void	setWeight (double const weight)

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

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

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

std::pair< Id, Id > const &	nodePair () const
	Get the edge's node pair.

geometry::PolyLine const &	geometry () const
	Get the edge's geometry.

double	angle () const
	Get the edge's angle, in radians, between the source and target nodes.

double	weight () const
	Get the edge's weight.

virtual bool	isFull () const =0

double	deltaAngle (double const previousEdgeAngle) const

Static Public Member Functions
static void	setMeanVehicleLength (double meanVehicleLength)
	Set the mean vehicle length, in meters (default is 5)

static double	meanVehicleLength ()
	Get the mean vehicle length.

Protected Attributes
double	m_length

double	m_maxSpeed

int	m_nLanes

int	m_capacity

double	m_transportCapacity

std::string	m_name

int	m_priority

std::set< Id >	m_forbiddenTurns

Protected Attributes inherited from dsf::Edge
geometry::PolyLine	m_geometry

Id	m_id

std::pair< Id, Id >	m_nodePair

std::optional< double >	m_weight

double	m_angle

Static Protected Attributes
static double	m_meanVehicleLength = 5.

Additional Inherited Members
Protected Member Functions inherited from dsf::Edge
void	m_setAngle (geometry::Point srcNodeCoordinates, geometry::Point dstNodeCoordinates)

Constructor & Destructor Documentation

◆ Road()

dsf::mobility::Road::Road	(	Id	id,
		std::pair< Id, Id >	nodePair,
		double	length = m_meanVehicleLength,
		double	maxSpeed = 13.8888888889,
		int	nLanes = 1,
		std::string	name = std::string(),
		geometry::PolyLine	geometry = {},
		std::optional< int >	capacity = std::nullopt,
		double	transportCapacity = 1. )

Construct a new Road object.

Parameters

id	The road's id
nodePair	The road's node pair
length	The road's length, in meters (default is the mean vehicle length)
nLanes	The road's number of lanes (default is 1)
maxSpeed	The road's speed limit, in m/s (default is 50 km/h)
name	The road's name (default is an empty string)
capacity	The road's capacity (default is the maximum number of vehicles that can fit in the road)
transportCapacity	The road's transport capacity (default is 1)

Member Function Documentation

◆ addForbiddenTurn()

void dsf::mobility::Road::addForbiddenTurn ( Id roadId )

Add a road id to the forbidden turns.

Parameters

roadId The road id to add

◆ capacity()

int dsf::mobility::Road::capacity ( ) const

Get the road's capacity, in number of agents.

Returns: int The road's capacity, in number of agents

◆ density()

virtual double dsf::mobility::Road::density ( bool normalized = false ) const

pure virtual

Implemented in dsf::mobility::Street.

◆ forbiddenTurns()

std::set< Id > const & dsf::mobility::Road::forbiddenTurns ( ) const

Get the road's forbidden turns.

Returns: std::set<Id> The road's forbidden turns

The forbidden turns are the road ids that are not allowed to be used by the agents when they are on the road.

◆ length()

double dsf::mobility::Road::length ( ) const

Get the length, in meters.

Returns: double The length, in meters

◆ maxSpeed()

double dsf::mobility::Road::maxSpeed ( ) const

Get the maximum speed, in meters per second.

Returns: double The maximum speed, in meters per second

◆ meanVehicleLength()

double dsf::mobility::Road::meanVehicleLength ( )

static

Get the mean vehicle length.

Returns: double The mean vehicle length

◆ nAgents()

virtual int dsf::mobility::Road::nAgents ( ) const

pure virtual

Implemented in dsf::mobility::Street.

◆ name()

std::string dsf::mobility::Road::name ( ) const

Get the name.

Returns: std::string The name

◆ nExitingAgents()

virtual double dsf::mobility::Road::nExitingAgents	(	Direction	direction,
		bool	normalizeOnNLanes ) const

pure virtual

Implemented in dsf::mobility::Street.

◆ nLanes()

int dsf::mobility::Road::nLanes ( ) const

Get the number of lanes.

Returns: int The number of lanes

◆ nMovingAgents()

virtual int dsf::mobility::Road::nMovingAgents ( ) const

pure virtual

Implemented in dsf::mobility::Street.

◆ priority()

int dsf::mobility::Road::priority ( ) const

Get the priority.

Returns: int The priority

◆ setCapacity()

void dsf::mobility::Road::setCapacity ( int capacity )

Set the capacity, in number of agents.

Parameters

capacity The capacity

Exceptions

std::invalid_argument If the capacity is less or equal to 0

◆ setForbiddenTurns()

void dsf::mobility::Road::setForbiddenTurns ( std::set< Id > const & forbiddenTurns )

Replace the road's forbidden turns with the given set.

Parameters

forbiddenTurns The set of forbidden turns

◆ setMaxSpeed()

void dsf::mobility::Road::setMaxSpeed ( double speed )

Set the maximum speed, in meters per second (default is 50 km/h)

Parameters

speed The maximum speed

Exceptions

std::invalid_argument If the speed is less or equal to 0

◆ setMeanVehicleLength()

void dsf::mobility::Road::setMeanVehicleLength ( double meanVehicleLength )

static

Set the mean vehicle length, in meters (default is 5)

Parameters

meanVehicleLength The mean vehicle length

Exceptions

std::invalid_argument If the mean vehicle length is less or equal to 0

◆ setPriority()

void dsf::mobility::Road::setPriority ( int priority )

Set the road's priority.

Parameters

priority The road's priority

◆ setTransportCapacity()

void dsf::mobility::Road::setTransportCapacity ( double transportCapacity )

Set the transport capacity, in number of agents.

Parameters

transportCapacity The transport capacity

Exceptions

std::invalid_argument If the transport capacity is less or equal to 0

◆ transportCapacity()

double dsf::mobility::Road::transportCapacity ( ) const

Get the road's transport capacity, in number of agents.

Returns: double The road's transport capacity, in number of agents

◆ turnDirection()

Direction dsf::mobility::Road::turnDirection ( double const & previousStreetAngle ) const

Get the road's turn direction given the previous road angle.

Parameters

previousStreetAngle The angle of the previous road

Returns: Direction The turn direction

The turn direction is the direction that the agent must take when it is on the road. The possible values are:

UTURN (abs of delta is greater than pi)
STRAIGHT (abs of delta is less than pi /8)
RIGHT (delta is negative and not covered by the above conditions)
LEFT (delta is positive and not covered by the above conditions)

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

src/dsf/mobility/Road.hpp
src/dsf/mobility/Road.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Road()

Member Function Documentation

◆ addForbiddenTurn()

◆ capacity()

◆ density()

◆ forbiddenTurns()

◆ length()

◆ maxSpeed()

◆ meanVehicleLength()

◆ nAgents()

◆ name()

◆ nExitingAgents()

◆ nLanes()

◆ nMovingAgents()

◆ priority()

◆ setCapacity()

◆ setForbiddenTurns()

◆ setMaxSpeed()

◆ setMeanVehicleLength()

◆ setPriority()

◆ setTransportCapacity()

◆ transportCapacity()

◆ turnDirection()