scenario_simulator_v2 C++ API
Public Member Functions | Public Attributes | List of all members
traffic_simulator::job::Job Class Reference

#include <job.hpp>

Public Member Functions

 Job (const std::function< bool(double)> &func_on_update, const std::function< void()> &func_on_cleanup, job::Type type, bool exclusive, Event event)
 Construct a new Job object. More...
 
void onUpdate (const double step_time)
 
void inactivate ()
 
Status getStatus () const
 

Public Attributes

const job::Type type
 
const bool exclusive
 
const Event event
 

Constructor & Destructor Documentation

◆ Job()

traffic_simulator::job::Job::Job ( const std::function< bool(double)> &  func_on_update,
const std::function< void()> &  func_on_cleanup,
job::Type  type,
bool  exclusive,
Event  event 
)

Construct a new Job object.

Parameters
func_on_updateIf func_on_update function returns true, runs func_on_update function.
func_on_cleanupIf func_on_update function returns true, runs func_on_update function.
typeType of the Job
exclusiveIf true, the Job works exclusively by type.

Member Function Documentation

◆ getStatus()

Status traffic_simulator::job::Job::getStatus ( ) const

◆ inactivate()

void traffic_simulator::job::Job::inactivate ( )

◆ onUpdate()

void traffic_simulator::job::Job::onUpdate ( const double  step_time)

Member Data Documentation

◆ event

const Event traffic_simulator::job::Job::event

◆ exclusive

const bool traffic_simulator::job::Job::exclusive

◆ type

const job::Type traffic_simulator::job::Job::type

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