dsf::mobility::Roundabout Class Reference

The Roundabout class represents a roundabout node in the network. More...

#include <Roundabout.hpp>

Inheritance diagram for dsf::mobility::Roundabout:

Public Member Functions
	Roundabout (Id id)
	Construct a new Roundabout object.
	Roundabout (Id id, geometry::Point point)
	Construct a new Roundabout object.
	Roundabout (const RoadJunction &node)
	Construct a new Roundabout object.
void	enqueue (std::unique_ptr< Agent > agentId)
	Put an agent in the node.
std::unique_ptr< Agent >	dequeue ()
	Removes the first agent from the node.
dsf::queue< std::unique_ptr< Agent > > const &	agents () const
	Get the node's queue.
double	density () const override
	Returns the node's density.
bool	isFull () const override
	Returns true if the node is full.
constexpr bool	isRoundabout () const noexcept final
	Returns true if the node is a roundabout.
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)
virtual void	setCapacity (std::size_t const capacity)
	Set the junction's capacity.
void	setTransportCapacity (double capacity)
	Set the junction's transport capacity.
std::size_t	capacity () const
	Get the junction's capacity.
double	transportCapacity () const
	Get the junction's transport capacity.
virtual constexpr bool	isIntersection () const noexcept
virtual constexpr bool	isTrafficLight () 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.
void	setAttribute (std::string const &name, std::variant< std::monostate, bool, std::int64_t, double, std::string > const &value)
	Set an attribute for the node.
auto	id () const
	Get the node's id.
auto const &	geometry () const noexcept
	Get the node's geometry.
auto const &	name () const noexcept
	Get the node's name.
auto const &	ingoingEdges () const noexcept
	Get the node's ingoing edges.
auto const &	outgoingEdges () const noexcept
	Get the node's outgoing edges.
auto const &	attributes () const noexcept
	Get the node's attributes.
template<typename T>
std::optional< T >	getAttribute (std::string const &name) const
	Get a specific attribute of the node.

Protected Attributes
dsf::queue< std::unique_ptr< Agent > >	m_agents
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
std::unordered_map< std::string, std::variant< std::monostate, bool, std::int64_t, double, std::string > >	m_attributes

Detailed Description

The Roundabout class represents a roundabout node in the network.

Constructor & Destructor Documentation

Roundabout() [1/3]

dsf::mobility::Roundabout::Roundabout ( Id id )

inlineexplicit

Construct a new Roundabout object.

Parameters

id	The node's id

Roundabout() [2/3]

dsf::mobility::Roundabout::Roundabout ( Id id, geometry::Point point )

inline

Construct a new Roundabout object.

Parameters

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

Roundabout() [3/3]

dsf::mobility::Roundabout::Roundabout

(

const RoadJunction &

node

)

Construct a new Roundabout object.

Parameters

node	An Intersection object

Member Function Documentation

agents()

dsf::queue< std::unique_ptr< Agent > > const & dsf::mobility::Roundabout::agents ( ) const

inline

Get the node's queue.

Returns

dsf::queue<Id> The node's queue

density()

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

inlineoverridevirtual

Returns the node's density.

Returns

double The node's density

Reimplemented from dsf::mobility::RoadJunction.

dequeue()

std::unique_ptr< Agent > dsf::mobility::Roundabout::dequeue

(

)

Removes the first agent from the node.

Returns

Id The agent's id

enqueue()

void dsf::mobility::Roundabout::enqueue

(

std::unique_ptr< Agent >

agentId

)

Put an agent in the node.

Parameters

agentId

The agent's id

Exceptions

std::runtime_error

if the node is full

isFull()

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

inlineoverridevirtual

Returns true if the node is full.

Returns

bool True if the node is full

Reimplemented from dsf::mobility::RoadJunction.

isRoundabout()

bool dsf::mobility::Roundabout::isRoundabout ( ) const

inlineconstexprfinalvirtualnoexcept

Returns true if the node is a roundabout.

Returns

bool True if the node is a roundabout

Reimplemented from dsf::mobility::RoadJunction.

---

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

• src/dsf/mobility/Roundabout.hpp
• src/dsf/mobility/Roundabout.cpp