OpenTTD Source  1.11.2
flowmapper.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef FLOWMAPPER_H_
11 #define FLOWMAPPER_H_
12 
13 #include "linkgraphjob_base.h"
14 
22 class FlowMapper : public ComponentHandler {
23 public:
24 
31  virtual void Run(LinkGraphJob &job) const;
32 
36  virtual ~FlowMapper() {}
37 private:
38 
42  const bool scale;
43 };
44 
45 #endif /* FLOWMAPPER_H_ */
FlowMapper::Run
virtual void Run(LinkGraphJob &job) const
Map the paths generated by the MCF solver into flows associated with nodes.
Definition: flowmapper.cpp:19
linkgraphjob_base.h
LinkGraphJob
Class for calculation jobs to be run on link graphs.
Definition: linkgraphjob.h:30
ComponentHandler
A handler doing "something" on a link graph component.
Definition: linkgraphschedule.h:21
FlowMapper::scale
const bool scale
Whether the flow mapper should scale all flows to monthly values.
Definition: flowmapper.h:42
FlowMapper
Map the path trees generated by the MCF solver into flows.
Definition: flowmapper.h:22
FlowMapper::FlowMapper
FlowMapper(bool scale)
Create a flow mapper.
Definition: flowmapper.h:30
FlowMapper::~FlowMapper
virtual ~FlowMapper()
Virtual destructor has to be defined because of virtual Run().
Definition: flowmapper.h:36