/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */

/** @file base_consist.h Properties for front vehicles/consists. */

#ifndef BASE_CONSIST_H
#define BASE_CONSIST_H

#include "order_type.h"
#include "date_type.h"
#include "timetable.h"
#include "core/tinystring_type.hpp"
#include "3rdparty/cpp-btree/btree_map.h"

struct LastDispatchRecord {
	enum RecordFlags {
		RF_FIRST_SLOT = 0,  ///< Dispatch slot was first
		RF_LAST_SLOT,       ///< Dispatch slot was last
	};

	StateTicks dispatched;
	uint32_t offset;
	uint16_t slot_flags;
	uint8_t record_flags;
};

/** Various front vehicle properties that are preserved when autoreplacing, using order-backup or switching front engines within a consist. */
struct BaseConsist {
	TinyString name;                          ///< Name of vehicle

	btree::btree_map<uint16_t, LastDispatchRecord> dispatch_records; ///< Records of last scheduled dispatches

	/* Used for timetabling. */
	uint32_t current_order_time;              ///< How many ticks have passed since this order started.
	int32_t lateness_counter;                 ///< How many ticks late (or early if negative) this vehicle is.
	StateTicks timetable_start;               ///< When the vehicle is supposed to start the timetable.

	uint16_t service_interval;                ///< The interval for (automatic) servicing; either in days or %.

	VehicleOrderID cur_real_order_index;      ///< The index to the current real (non-implicit) order
	VehicleOrderID cur_implicit_order_index;  ///< The index to the current implicit order
	VehicleOrderID cur_timetable_order_index; ///< The index to the current real (non-implicit) order used for timetable updates

	uint32_t vehicle_flags;                   ///< Used for gradual loading and other miscellaneous things (@see VehicleFlags enum)

	virtual ~BaseConsist() = default;

	void CopyConsistPropertiesFrom(const BaseConsist *src);
};

#endif /* BASE_CONSIST_H */