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