traffic_simulator::traffic::TrafficSink Class Reference

#include <traffic_sink.hpp>

Inheritance diagram for traffic_simulator::traffic::TrafficSink:

Collaboration diagram for traffic_simulator::traffic::TrafficSink:

Public Member Functions
	TrafficSink (const std::function< void(const std::string &)> &despawn_function, const std::shared_ptr< entity::EntityManager > entity_manager_ptr, const TrafficSinkConfig &config)
	Construct a new Traffic Sink object. More...
auto	execute (const double current_time, const double step_time) -> void override
auto	appendDebugMarker (visualization_msgs::msg::MarkerArray &marker_array) const -> void override
Public Member Functions inherited from traffic_simulator::traffic::TrafficModuleBase
	TrafficModuleBase ()

Constructor & Destructor Documentation

TrafficSink()

traffic_simulator::traffic::TrafficSink::TrafficSink ( const std::function< void(const std::string &)> &  despawn_function, const std::shared_ptr< entity::EntityManager >  entity_manager_ptr, const TrafficSinkConfig &  config  )

explicit

Construct a new Traffic Sink object.

Parameters

entity_manager_ptr	Shared pointer, refers to the EntityManager
config	TrafficSink configuration

Member Function Documentation

appendDebugMarker()

auto traffic_simulator::traffic::TrafficSink::appendDebugMarker ( visualization_msgs::msg::MarkerArray &  marker_array ) const -> void

overridevirtual

Reimplemented from traffic_simulator::traffic::TrafficModuleBase.

execute()

auto traffic_simulator::traffic::TrafficSink::execute ( const double  current_time, const double  step_time  ) -> void

overridevirtual

Note

execute calls despawn on each entity only when both:

1. Its distance from the TrafficSink is <= config.radius [m].
2. Its EntityType is in config.sinkable_entity_types.

Implements traffic_simulator::traffic::TrafficModuleBase.

---

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

• simulation/traffic_simulator/include/traffic_simulator/traffic/traffic_sink.hpp
• simulation/traffic_simulator/src/traffic/traffic_sink.cpp