src/vehiclelist_func.h

   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
   8 /** @file vehiclelist_func.h Functions and type for generating vehicle lists. */
   9
  10 #ifndef VEHICLELIST_FUNC_H
  11 #define VEHICLELIST_FUNC_H
  12
  13 #include "order_base.h"
  14 #include "vehicle_base.h"
  15
  16 /**
  17  * Find vehicles matching an order.
  18  * This can be used, e.g. to find all vehicles that stop at a particular station.
  19  * @param veh_pred Vehicle selection predicate. This is called only for the first vehicle using the order list.
  20  * @param ord_pred Order selection predicate.
  21  * @param veh_func Called for each vehicle that matches both vehicle and order predicates.
  22  **/
  23 template <class VehiclePredicate, class OrderPredicate, class VehicleFunc>
  24 void FindVehiclesWithOrder(VehiclePredicate veh_pred, OrderPredicate ord_pred, VehicleFunc veh_func)
  25 {
  26         for (const OrderList *orderlist : OrderList::Iterate()) {
  27
  28                 /* We assume all vehicles sharing an order list match the condition. */
  29                 Vehicle *v = orderlist->GetFirstSharedVehicle();
  30                 if (!veh_pred(v)) continue;
  31
  32                 /* Vehicle is a candidate, search for a matching order. */
  33                 for (const Order *order = orderlist->GetFirstOrder(); order != nullptr; order = order->next) {
  34
  35                         if (!ord_pred(order)) continue;
  36
  37                         /* An order matches, we can add all shared vehicles to the list. */
  38                         for (; v != nullptr; v = v->NextShared()) {
  39                                 veh_func(v);
  40                         }
  41                         break;
  42                 }
  43         }
  44 }
  45
  46 #endif /* VEHICLELIST_FUNC_H */