src/base_consist.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file base_consist.h Properties for front vehicles/consists. */
  11
  12 #ifndef BASE_CONSIST_H
  13 #define BASE_CONSIST_H
  14
  15 #include "order_type.h"
  16 #include "date_type.h"
  17
  18 /** Various front vehicle properties that are preserved when autoreplacing, using order-backup or switching front engines within a consist. */
  19 struct BaseConsist {
  20         char *name;                         ///< Name of vehicle
  21
  22         /* Used for timetabling. */
  23         uint32 current_order_time;          ///< How many ticks have passed since this order started.
  24         uint32 current_loading_time;        ///< Used for timetabling
  25         int32 lateness_counter;             ///< How many ticks late (or early if negative) this vehicle is.
  26         Date timetable_start;               ///< When the vehicle is supposed to start the timetable.
  27
  28         uint16 service_interval;            ///< The interval for (automatic) servicing; either in days or %.
  29
  30         VehicleOrderID cur_real_order_index;///< The index to the current real (non-implicit) order
  31         VehicleOrderID cur_implicit_order_index;///< The index to the current implicit order
  32         VehicleOrderID cur_timetable_order_index;///< The index to the current real (non-implicit) order used for timetable updates
  33
  34         uint16 vehicle_flags;               ///< Used for gradual loading and other miscellaneous things (@see VehicleFlags enum)
  35
  36         BaseConsist() : name(NULL) {}
  37         virtual ~BaseConsist();
  38
  39         void CopyConsistPropertiesFrom(const BaseConsist *src);
  40 };
  41
  42 #endif /* BASE_CONSIST_H */