dsm::SpireStreet Class Reference

The SpireStreet class represents a street which is able to count agent flows in both input and output. More...

#include <Street.hpp>

Inheritance diagram for dsm::SpireStreet:

Public Member Functions
void	addAgent (Id agentId) final
	Add an agent to the street's queue.
int	meanFlow ()
	Get the mean flow of the street.
std::optional< Id >	dequeue (size_t index) final
	Remove an agent from the street's queue.
bool	isSpire () const final
	Check if the street is a spire.
	Street (Id id, const Street &)
	Construct a new Street object starting from an existing street.
	Street (Id id, std::pair< Id, Id > nodePair, double length=Road::meanVehicleLength(), double maxSpeed=13.8888888889, int nLanes=1, std::string name=std::string(), std::optional< int > capacity=std::nullopt, int transportCapacity=1)
	Construct a new Street object.
Public Member Functions inherited from dsm::Street
	Street (Id id, const Street &)
	Construct a new Street object starting from an existing street.
	Street (Id id, std::pair< Id, Id > nodePair, double length=Road::meanVehicleLength(), double maxSpeed=13.8888888889, int nLanes=1, std::string name=std::string(), std::optional< int > capacity=std::nullopt, int transportCapacity=1)
	Construct a new Street object.
void	setQueue (dsm::queue< Size > queue, size_t index)
	Set the street's queue.
std::vector< Id > const &	movingAgents () const
	Get the street's waiting agents.
const dsm::queue< Size > &	queue (size_t index) const
	Get the street's queue.
const std::vector< dsm::queue< Size > > &	exitQueues () const
	Get the street's queues.
int	nAgents () const final
	Get the number of agents on the street.
double	density (bool normalized=false) const final
	Get the street's density in or in , if normalized.
bool	isFull () const final
	Check if the street is full.
int	nMovingAgents () const override
int	nExitingAgents () const final
	Get the number of agents on all queues.
std::vector< Direction > const &	laneMapping () const
void	addAgent (Id agentId) override
void	enqueue (Id agentId, size_t index)
	Add an agent to the street's queue.
virtual bool	isStochastic () const
Public Member Functions inherited from dsm::Road
	Road (Id id, const Road &)
	Construct a new Road object starting from an existing 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(), std::optional< int > capacity=std::nullopt, int transportCapacity=1)
	Construct a new Road object.
void	setMaxSpeed (double speed)
	Set the maximum speed, in meters per second (default is 50 km/h)
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.
std::string	name () const
	Get the name.
Public Member Functions inherited from dsm::Edge
	Edge (Id id, std::pair< Id, Id > nodePair, int capacity=1, int transportCapacity=1, double angle=0.0)
	Construct a new Edge object.
void	setCapacity (int capacity)
void	setTransportCapacity (int capacity)
void	setAngle (std::pair< double, double > srcNodeCoordinates, std::pair< double, double > dstNodeCoordinates)
Id	id () const
	Get the edge's id.
Id	u () const
	Get the edge's source node id.
Id	v () const
	Get the edge's destination node id.
std::pair< Id, Id > const &	nodePair () const
	Get the edge's node pair.
int	capacity () const
	Get the edge's capacity, in number of agents.
int	transportCapacity () const
	Get the edge's transport capacity, in number of agents.
double	angle () const
	Get the edge's angle, in radians, between the source and destination nodes.
double	deltaAngle (double const previousEdgeAngle) const
Public Member Functions inherited from dsm::Counter
void	increaseInputCounter ()
	Increase the input counter by one.
void	increaseOutputCounter ()
	Increase the output counter by one.
int	inputCounts (bool reset=true)
	Get the number of input counts registered.
int	outputCounts (bool reset=true)
	Get the number of output counts registered.

Additional Inherited Members
Static Public Member Functions inherited from dsm::Street
static void	setMeanVehicleLength (double meanVehicleLength)
	Set the mean vehicle length.
Static Public Member Functions inherited from dsm::Road
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 inherited from dsm::Road
double	m_length
double	m_maxSpeed
int	m_nLanes
std::string	m_name
Protected Attributes inherited from dsm::Edge
Id	m_id
std::pair< Id, Id >	m_nodePair
int	m_capacity
int	m_transportCapacity
double	m_angle
Protected Attributes inherited from dsm::Counter
std::pair< int, int >	m_counters = {0, 0}
Static Protected Attributes inherited from dsm::Road
static double	m_meanVehicleLength

Detailed Description

The SpireStreet class represents a street which is able to count agent flows in both input and output.

Template Parameters

Id	The type of the street's id
Size	The type of the street's capacity

Member Function Documentation

addAgent()

void dsm::SpireStreet::addAgent ( Id agentId )

finalvirtual

Add an agent to the street's queue.

Parameters

agentId

The id of the agent to add to the street's queue

Exceptions

std::runtime_error

If the street's queue is full

Implements dsm::Road.

dequeue()

std::optional< Id > dsm::SpireStreet::dequeue ( size_t index )

finalvirtual

Remove an agent from the street's queue.

Returns

std::optional<Id> The id of the agent removed from the street's queue

Reimplemented from dsm::Street.

isSpire()

bool dsm::SpireStreet::isSpire ( ) const

inlinefinalvirtual

Check if the street is a spire.

Returns

bool True if the street is a spire, false otherwise

Reimplemented from dsm::Street.

meanFlow()

int dsm::SpireStreet::meanFlow

(

)

Get the mean flow of the street.

Returns

int The flow of the street, i.e. the difference between input and output flows

Once the flow is retrieved, bothh the input and output flows are reset to 0. Notice that this flow is positive iff the input flow is greater than the output flow.

Street() [1/2]

dsm::Street::Street	(	Id	id,
		const Street &	)

Construct a new Street object starting from an existing street.

The new street has different id but same capacity, length, speed limit, and node pair as the existing street.

Parameters

Street	The existing street
id	The new street's id

Street() [2/2]

dsm::Street::Street	(	Id	id,
		std::pair< Id, Id >	nodePair,
		double	length = Road::meanVehicleLength(),
		double	maxSpeed = 13.8888888889,
		int	nLanes = 1,
		std::string	name = std::string(),
		std::optional< int >	capacity = std::nullopt,
		int	transportCapacity = 1 )

Construct a new Street object.

Parameters

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

---

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

• src/dsm/headers/Street.hpp