Processing math: 100%
Dynamical system model
All Classes Namespaces Files Functions Pages
dsm::StochasticStreet Class Reference

A stochastic street is a street with a flow rate parameter. More...

#include <Street.hpp>

Inheritance diagram for dsm::StochasticStreet:
dsm::Street dsm::Road dsm::Edge dsm::StochasticSpireStreet

Public Member Functions

 StochasticStreet (Street &&, double flowRate)
 
 StochasticStreet (Id id, std::pair< Id, Id > nodePair, double length=Road::meanVehicleLength(), double maxSpeed=13.8888888889, int nLanes=1, std::string name=std::string(), std::vector< std::pair< double, double > > geometry={}, double flowRate=1., std::optional< int > capacity=std::nullopt, double transportCapacity=1.)
 
void setFlowRate (double const flowRate)
 
double flowRate () const
 
bool isStochastic () const final
 
- Public Member Functions inherited from 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::vector< std::pair< double, double > > geometry={}, std::optional< int > capacity=std::nullopt, double transportCapacity=1.)
 Construct a new Street object.
 
 Street (Street &&)=default
 
 Street (Street const &)=delete
 
void setLaneMapping (std::vector< Direction > const &laneMapping)
 Set the street's lane mapping.
 
void setQueue (dsm::queue< std::unique_ptr< Agent > > queue, size_t index)
 Set the street's queue.
 
const dsm::queue< std::unique_ptr< Agent > > & queue (size_t const &index) const
 Get the street's queue.
 
std::vector< dsm::queue< std::unique_ptr< Agent > > > const & 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 m^{-1} or in a.u., if normalized.
 
bool isFull () const final
 Check if the street is full.
 
dsm::priority_queue< std::unique_ptr< Agent >, std::vector< std::unique_ptr< Agent > >, AgentComparator > & movingAgents ()
 
int nMovingAgents () const override
 Get the number of of moving agents, i.e. agents not yet enqueued.
 
double nExitingAgents (Direction direction=Direction::ANY, bool normalizeOnNLanes=false) const final
 Get the number of agents on all queues for a given direction.
 
std::vector< Direction > const & laneMapping () const
 
virtual void addAgent (std::unique_ptr< Agent > pAgent)
 
void enqueue (size_t const &queueId)
 Add an agent to the street's queue.
 
virtual std::unique_ptr< Agentdequeue (size_t index)
 Remove an agent from the street's queue.
 
virtual bool isSpire () const
 Check if the street is a spire.
 
- Public Member Functions inherited from dsm::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::vector< std::pair< double, double > > 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 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.
 
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.
 
- Public Member Functions inherited from dsm::Edge
 Edge (Id id, std::pair< Id, Id > nodePair, int capacity=1, double transportCapacity=1., std::vector< std::pair< double, double > > geometry={})
 Construct a new Edge object.
 
 Edge (Edge &&)=default
 
 Edge (const Edge &)=delete
 
void resetId (Id newId)
 
void setCapacity (int capacity)
 
void setTransportCapacity (double capacity)
 
void setGeometry (std::vector< std::pair< double, double > > geometry)
 
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.
 
std::vector< std::pair< double, double > > const & geometry () const
 
int capacity () const
 Get the edge's capacity, in number of agents.
 
double 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 target nodes.
 
double deltaAngle (double const previousEdgeAngle) const
 

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 Member Functions inherited from dsm::Edge
void m_setAngle (std::pair< double, double > srcNodeCoordinates, std::pair< double, double > dstNodeCoordinates)
 
- Protected Attributes inherited from dsm::Road
double m_length
 
double m_maxSpeed
 
int m_nLanes
 
std::string m_name
 
int m_priority
 
std::set< Id > m_forbiddenTurns
 
- Protected Attributes inherited from dsm::Edge
std::vector< std::pair< double, double > > m_geometry
 
Id m_id
 
std::pair< Id, Id > m_nodePair
 
int m_capacity
 
double m_transportCapacity
 
double m_angle
 
- Static Protected Attributes inherited from dsm::Road
static double m_meanVehicleLength
 

Detailed Description

A stochastic street is a street with a flow rate parameter.

The Stochastic Street is used to replace traffic lights with a lower level of detail. The idea is to model the flow of agents in a street as a stochastic process, limiting the number of agents that can exit using a parameter in [0, 1]. Thus, the flow rate parameter represents the ratio between the green time of the traffic light and the total time of the traffic light cycle.

Member Function Documentation

◆ isStochastic()

bool dsm::StochasticStreet::isStochastic ( ) const
finalvirtual

Reimplemented from dsm::Street.


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