Dynamical System Framework
Loading...
Searching...
No Matches
dsf::mobility::Agent Class Reference

The Agent class represents an agent in the network. More...

#include <Agent.hpp>

Public Member Functions

 Agent (Id const id, std::time_t const &spawnTime, std::optional< Id > destination=std::nullopt, std::optional< Id > srcNodeId=std::nullopt)
 Construct a new Agent object.
void setSrcNodeId (Id srcNodeId)
 Set the id of the source node of the agent.
void setSpawnTime (std::time_t const &spawnTime)
 Set the agent's spawn time.
void setStreetId (std::optional< Id > streetId=std::nullopt)
 Set the street occupied by the agent.
auto setSrcStreetId (Id srcStreetId)
 Set the id of the first street of the agent's trip.
auto setNextStreetId (Id nextStreetId)
 Set the id of the next street.
void setSpeed (double speed)
 Set the agent's speed.
void setFreeTime (std::time_t const &freeTime)
 Set the agent's free time.
void incrementDistance (double distance)
 Increment the agent's distance by a given value.
void setMaxDistance (double const maxDistance)
 Set the agent's maximum distance.
void setMaxTime (std::time_t const maxTime)
 Set the agent's maximum time.
void setIntelligent (bool const isIntelligent) noexcept
 Set whether the agent is intelligent.
void setPath (std::span< Id const > streets)
 Set the streets the agent plans to take after the one it is on (or, before its departure, after its first street).
void dropPath () noexcept
 Drop the agent's planned streets, so that its route is planned again when needed; the destination is kept.
void advancePath ()
 Remove the next planned street, once the agent takes it.
void reset (std::time_t const &spawnTime)
 Reset the agent.
std::time_t const & spawnTime () const noexcept
 Get the agent's spawn time.
std::time_t const & freeTime () const noexcept
 Get the agent's free time.
Id id () const noexcept
 Get the agent's id.
std::optional< Id > destination () const noexcept
 Get the agent's destination street.
auto maxDistance () const
 Get the agent's maximum distance.
auto maxTime () const
 Get the agent's maximum time.
std::optional< Id > streetId () const noexcept
 Get the id of the street currently occupied by the agent.
std::optional< Id > srcNodeId () const noexcept
 Get the id of the source node of the agent.
std::optional< Id > srcStreetId () const noexcept
 Get the id of the first street of the agent's trip.
std::optional< Id > nextStreetId () const noexcept
 Get the id of the next street.
double speed () const noexcept
 Get the agent's speed.
double distance () const noexcept
 Get the agent's travelled distance.
bool isRandom () const noexcept
 Return true if the agent is a random agent.
bool isIntelligent () const noexcept
 Return true if the agent is intelligent.
std::optional< Id > nextPlannedStreetId () const noexcept
 Get the next planned street.
std::size_t nPlannedStreets () const noexcept
 Get the number of planned streets.
bool hasArrived (std::optional< std::time_t > const &currentTime) const noexcept
 Check if a random agent has arrived at its destination.

Detailed Description

The Agent class represents an agent in the network.

Constructor & Destructor Documentation

◆ Agent()

dsf::mobility::Agent::Agent ( Id const id,
std::time_t const & spawnTime,
std::optional< Id > destination = std::nullopt,
std::optional< Id > srcNodeId = std::nullopt )

Construct a new Agent object.

Parameters
idThe agent's id
spawnTimeThe agent's spawn time
destinationOptional, the id of the agent's destination street: the agent travels it, and arrives at its end. If not provided, the agent is a random agent
srcNodeIdOptional, The id of the source node of the agent

Member Function Documentation

◆ advancePath()

void dsf::mobility::Agent::advancePath ( )

Remove the next planned street, once the agent takes it.

Exceptions
std::logic_errorif there is no planned street

◆ destination()

std::optional< Id > dsf::mobility::Agent::destination ( ) const
inlinenoexcept

Get the agent's destination street.

Returns
std::optional<Id> The id of the destination street, std::nullopt for a random agent

◆ distance()

double dsf::mobility::Agent::distance ( ) const
inlinenoexcept

Get the agent's travelled distance.

Returns
The agent's travelled distance

◆ freeTime()

std::time_t const & dsf::mobility::Agent::freeTime ( ) const
inlinenoexcept

Get the agent's free time.

Returns
The agent's free time

◆ hasArrived()

bool dsf::mobility::Agent::hasArrived ( std::optional< std::time_t > const & currentTime) const
inlinenoexcept

Check if a random agent has arrived at its destination.

Parameters
currentTimeThe current simulation time
Returns
True if the agent has arrived (exceeded max distance or time), false otherwise

◆ id()

Id dsf::mobility::Agent::id ( ) const
inlinenoexcept

Get the agent's id.

Returns
The agent's id

◆ incrementDistance()

void dsf::mobility::Agent::incrementDistance ( double distance)

Increment the agent's distance by a given value.

Parameters
distanceThe value to increment the agent's distance byù
Exceptions
std::invalid_argument,ifdistance is negative

◆ isIntelligent()

bool dsf::mobility::Agent::isIntelligent ( ) const
inlinenoexcept

Return true if the agent is intelligent.

Returns
True if the agent plans its routes on the current traffic, false if it plans them on free-flow travel times

◆ isRandom()

bool dsf::mobility::Agent::isRandom ( ) const
inlinenoexcept

Return true if the agent is a random agent.

Returns
True if the agent is a random agent, false otherwise

◆ maxDistance()

auto dsf::mobility::Agent::maxDistance ( ) const
inline

Get the agent's maximum distance.

Returns
The agent's maximum distance, or throw std::logic_error if not set

◆ maxTime()

auto dsf::mobility::Agent::maxTime ( ) const
inline

Get the agent's maximum time.

Returns
The agent's maximum time, or throw std::logic_error if not set

◆ nextPlannedStreetId()

std::optional< Id > dsf::mobility::Agent::nextPlannedStreetId ( ) const
inlinenoexcept

Get the next planned street.

Returns
std::optional<Id> The street id, or std::nullopt if no street is planned

◆ nextStreetId()

std::optional< Id > dsf::mobility::Agent::nextStreetId ( ) const
inlinenoexcept

Get the id of the next street.

Returns
The id of the next street

◆ nPlannedStreets()

std::size_t dsf::mobility::Agent::nPlannedStreets ( ) const
inlinenoexcept

Get the number of planned streets.

Returns
std::size_t The number of streets the agent still plans to take

◆ reset()

void dsf::mobility::Agent::reset ( std::time_t const & spawnTime)

Reset the agent.

Reset the following values:

  • street id = std::nullopt
  • delay = 0
  • speed = 0
  • distance = 0
  • time = 0
  • planned streets = none (the destination is kept)

◆ setFreeTime()

void dsf::mobility::Agent::setFreeTime ( std::time_t const & freeTime)

Set the agent's free time.

Parameters
freeTimeThe agent's free time

◆ setIntelligent()

void dsf::mobility::Agent::setIntelligent ( bool const isIntelligent)
inlinenoexcept

Set whether the agent is intelligent.

Parameters
isIntelligentIf true, the agent plans its routes on the current traffic, otherwise on free-flow travel times

◆ setMaxDistance()

void dsf::mobility::Agent::setMaxDistance ( double const maxDistance)
inline

Set the agent's maximum distance.

Parameters
maxDistanceThe agent's maximum distance
Exceptions
std::invalid_argument,ifmaxDistance is not positive

◆ setMaxTime()

void dsf::mobility::Agent::setMaxTime ( std::time_t const maxTime)
inline

Set the agent's maximum time.

Parameters
maxTimeThe agent's maximum time

◆ setNextStreetId()

auto dsf::mobility::Agent::setNextStreetId ( Id nextStreetId)
inline

Set the id of the next street.

Parameters
nextStreetIdThe id of the next street

◆ setPath()

void dsf::mobility::Agent::setPath ( std::span< Id const > streets)

Set the streets the agent plans to take after the one it is on (or, before its departure, after its first street).

Parameters
streetsThe ids of the streets, in travel order
Exceptions
std::logic_errorif the agent is a random agent

◆ setSpawnTime()

void dsf::mobility::Agent::setSpawnTime ( std::time_t const & spawnTime)

Set the agent's spawn time.

Parameters
spawnTimeThe time-step at which the agent enters the simulation

The spawn time is stamped when the agent is created, but an agent may sit in the dynamics' pending list for an arbitrary number of time-steps before a free slot on its source node/street becomes available. Re-stamping it on actual insertion keeps the measured travel time the time spent in the network.

◆ setSpeed()

void dsf::mobility::Agent::setSpeed ( double speed)

Set the agent's speed.

Parameters
speed,Theagent's speed
Exceptions
std::invalid_argument,ifspeed is negative

◆ setSrcNodeId()

void dsf::mobility::Agent::setSrcNodeId ( Id srcNodeId)

Set the id of the source node of the agent.

Parameters
srcNodeIdThe id of the source node

◆ setSrcStreetId()

auto dsf::mobility::Agent::setSrcStreetId ( Id srcStreetId)
inline

Set the id of the first street of the agent's trip.

Parameters
srcStreetIdThe id of the first street, which must be an outgoing street of the agent's source node

◆ setStreetId()

void dsf::mobility::Agent::setStreetId ( std::optional< Id > streetId = std::nullopt)

Set the street occupied by the agent.

Parameters
streetIdThe id of the street currently occupied by the agent

◆ spawnTime()

std::time_t const & dsf::mobility::Agent::spawnTime ( ) const
inlinenoexcept

Get the agent's spawn time.

Returns
The agent's spawn time

◆ speed()

double dsf::mobility::Agent::speed ( ) const
inlinenoexcept

Get the agent's speed.

Returns
The agent's speed

◆ srcNodeId()

std::optional< Id > dsf::mobility::Agent::srcNodeId ( ) const
inlinenoexcept

Get the id of the source node of the agent.

Returns
The id of the source node of the agent

◆ srcStreetId()

std::optional< Id > dsf::mobility::Agent::srcStreetId ( ) const
inlinenoexcept

Get the id of the first street of the agent's trip.

Returns
The id of the first street of the agent's trip

◆ streetId()

std::optional< Id > dsf::mobility::Agent::streetId ( ) const
inlinenoexcept

Get the id of the street currently occupied by the agent.

Returns
The id of the street currently occupied by the agent

The documentation for this class was generated from the following files:
  • src/dsf/mobility/Agent.hpp
  • src/dsf/mobility/Agent.cpp