OpenTTD Source: ComponentHandler Class Reference

OpenTTD Source 15.3

Public Member Functions
ComponentHandler Class Referenceabstract

A handler doing "something" on a link graph component. More...

`#include <linkgraphschedule.h>`

Inheritance diagram for ComponentHandler:

## Public Member Functions
virtual | ~ComponentHandler ()=default
| Destroy the handler.
virtual void | Run (LinkGraphJob &job) const =0
| Run the handler.

## Detailed Description

A handler doing "something" on a link graph component.

It must not keep any state as it is called concurrently from different threads.

Definition at line 21 of file linkgraphschedule.h.

## Constructor & Destructor Documentation

## ◆ ~ComponentHandler()

virtual ComponentHandler::~ComponentHandler | ( |  | ) |
| virtualdefault

Destroy the handler.

Must be given due to virtual Run.

## Member Function Documentation

## ◆ Run()

virtual void ComponentHandler::Run | ( | LinkGraphJob & | job | ) | const
| pure virtual

Run the handler.

A link graph handler must not read or write any data outside the given component as that would create a potential desync.

Parameters

  job | Link graph component to run the handler on.

Implemented in DemandHandler, FlowMapper, InitHandler, and MCFHandler< Tpass >.

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

- src/linkgraph/linkgraphschedule.h