OpenTTD Source  20241121-master-g67a0fccfad
FlowMapper Class Reference

Map the path trees generated by the MCF solver into flows. More...

#include <flowmapper.h>

Inheritance diagram for FlowMapper:
ComponentHandler

Public Member Functions

 FlowMapper (bool scale)
 Create a flow mapper. More...
 
void Run (LinkGraphJob &job) const override
 Map the paths generated by the MCF solver into flows associated with nodes. More...
 
- Public Member Functions inherited from ComponentHandler
virtual ~ComponentHandler ()=default
 Destroy the handler. More...
 

Private Attributes

const bool scale
 Whether the flow mapper should scale all flows to monthly values.
 

Detailed Description

Map the path trees generated by the MCF solver into flows.

The path tree is useful to cache capacities and distances and allow quick disconnecting and reconnecting to other paths. The flows show how much cargo from which nodes is to be routed in which direction at a given node. This is what we need in the end.

Definition at line 22 of file flowmapper.h.

Constructor & Destructor Documentation

◆ FlowMapper()

FlowMapper::FlowMapper ( bool  scale)
inline

Create a flow mapper.

Parameters
scaleWhether the flow mapper should scale all flows to monthly values. Only do that on the very last flow mapping.

Definition at line 30 of file flowmapper.h.

Member Function Documentation

◆ Run()

void FlowMapper::Run ( LinkGraphJob job) const
overridevirtual

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