119 lines
4.2 KiB
C++
119 lines
4.2 KiB
C++
/* $Id: departures_type.h $ */
|
|
|
|
/*
|
|
* 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 departures_type.h Types related to departures. */
|
|
|
|
#ifndef DEPARTURES_TYPE_H
|
|
#define DEPARTURES_TYPE_H
|
|
|
|
#include "station_base.h"
|
|
#include "order_base.h"
|
|
#include "vehicle_base.h"
|
|
#include <vector>
|
|
|
|
/** Whether or not a vehicle has arrived for a departure. */
|
|
enum DepartureStatus : uint8_t {
|
|
D_TRAVELLING = 0,
|
|
D_ARRIVED = 1,
|
|
D_CANCELLED = 2,
|
|
};
|
|
|
|
/** The type of departures. */
|
|
enum DepartureType : uint8_t {
|
|
D_DEPARTURE = 0,
|
|
D_ARRIVAL = 1,
|
|
};
|
|
|
|
struct CallAt {
|
|
StationID station;
|
|
StateTicks scheduled_tick;
|
|
|
|
CallAt(const StationID& s) : station(s), scheduled_tick(0) { }
|
|
CallAt(const StationID& s, StateTicks t) : station(s), scheduled_tick(t) { }
|
|
CallAt(const CallAt& c) : station(c.station), scheduled_tick(c.scheduled_tick) { }
|
|
|
|
inline bool operator==(const CallAt& c) const {
|
|
return this->station == c.station;
|
|
}
|
|
|
|
inline bool operator!=(const CallAt& c) const {
|
|
return this->station != c.station;
|
|
}
|
|
|
|
inline bool operator>=(const CallAt& c) const {
|
|
return this->station == c.station &&
|
|
this->scheduled_tick != 0 &&
|
|
c.scheduled_tick != 0 &&
|
|
this->scheduled_tick >= c.scheduled_tick;
|
|
}
|
|
|
|
CallAt& operator=(const CallAt& c) {
|
|
this->station = c.station;
|
|
this->scheduled_tick = c.scheduled_tick;
|
|
return *this;
|
|
}
|
|
|
|
inline bool operator==(StationID s) const {
|
|
return this->station == s;
|
|
}
|
|
};
|
|
|
|
struct RemoveVia {
|
|
StationID via;
|
|
uint calling_at_offset;
|
|
};
|
|
|
|
/** A scheduled departure. */
|
|
struct Departure {
|
|
StateTicks scheduled_tick; ///< The tick this departure is scheduled to finish on (i.e. when the vehicle leaves the station)
|
|
Ticks lateness; ///< How delayed the departure is expected to be
|
|
StationID via; ///< The station the departure should list as going via
|
|
StationID via2; ///< Secondary station the departure should list as going via
|
|
CallAt terminus; ///< The station at which the vehicle will terminate following this departure
|
|
std::vector<CallAt> calling_at; ///< The stations both called at and unloaded at by the vehicle after this departure before it terminates
|
|
std::vector<RemoveVia> remove_vias; ///< Vias to remove when using smart terminus.
|
|
DepartureStatus status; ///< Whether the vehicle has arrived yet for this departure
|
|
DepartureType type; ///< The type of the departure (departure or arrival)
|
|
const Vehicle *vehicle; ///< The vehicle performing this departure
|
|
const Order *order; ///< The order corresponding to this departure
|
|
Ticks scheduled_waiting_time; ///< Scheduled waiting time if scheduled dispatch is used
|
|
Departure() : via(INVALID_STATION), via2(INVALID_STATION), terminus(INVALID_STATION), vehicle(nullptr), order(nullptr) { }
|
|
|
|
inline bool operator==(const Departure& d) const {
|
|
if (this->calling_at.size() != d.calling_at.size()) return false;
|
|
|
|
for (uint i = 0; i < this->calling_at.size(); ++i) {
|
|
if (this->calling_at[i] != d.calling_at[i]) return false;
|
|
}
|
|
|
|
const Ticks timetable_unit_size = TimetableDisplayUnitSize();
|
|
|
|
return
|
|
(this->scheduled_tick.base() / timetable_unit_size) == (d.scheduled_tick.base() / timetable_unit_size) &&
|
|
this->vehicle->type == d.vehicle->type &&
|
|
this->via == d.via &&
|
|
this->via2 == d.via2 &&
|
|
this->type == d.type
|
|
;
|
|
}
|
|
|
|
inline Ticks EffectiveWaitingTime() const
|
|
{
|
|
if (this->scheduled_waiting_time > 0) {
|
|
return this->scheduled_waiting_time;
|
|
} else {
|
|
return this->order->GetWaitTime();
|
|
}
|
|
}
|
|
};
|
|
|
|
typedef std::vector<Departure*> DepartureList;
|
|
|
|
#endif /* DEPARTURES_TYPE_H */
|