src/departures_type.h

   1 /* $Id: departures_type.h $ */
   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 departures_type.h Types related to departures. */
  11
  12 #ifndef DEPARTURES_TYPE_H
  13 #define DEPARTURES_TYPE_H
  14
  15 #include "station_base.h"
  16 #include "order_base.h"
  17 #include "vehicle_base.h"
  18
  19 /** Whether or not a vehicle has arrived for a departure. */
  20 typedef enum {
  21         D_TRAVELLING = 0,
  22         D_ARRIVED = 1,
  23         D_CANCELLED = 2,
  24 } DepartureStatus;
  25
  26 /** The type of departures. */
  27 typedef enum {
  28         D_DEPARTURE = 0,
  29         D_ARRIVAL = 1,
  30 } DepartureType;
  31
  32 typedef struct CallAt {
  33         StationID station;
  34         Ticks scheduled_date;
  35
  36         CallAt(const StationID& s) : station(s), scheduled_date(0) { }
  37         CallAt(const StationID& s, const Ticks& t) : station(s), scheduled_date(t) { }
  38         CallAt(const CallAt& c) : station(c.station), scheduled_date(c.scheduled_date) { }
  39
  40         inline bool operator==(const CallAt& c) const {
  41                 return this->station == c.station;
  42         }
  43
  44         inline bool operator!=(const CallAt& c) const {
  45                 return this->station != c.station;
  46         }
  47
  48         inline bool operator>=(const CallAt& c) const {
  49                 return this->station == c.station &&
  50                                 this->scheduled_date != 0 &&
  51                                 c.scheduled_date != 0 &&
  52                                 this->scheduled_date >= c.scheduled_date;
  53         }
  54
  55         CallAt& operator=(const CallAt& c) {
  56                 this->station = c.station;
  57                 this->scheduled_date = c.scheduled_date;
  58                 return *this;
  59         }
  60
  61         inline bool operator==(StationID s) const {
  62                 return this->station == s;
  63         }
  64 } CallAt;
  65
  66 /** A scheduled departure. */
  67 typedef struct Departure {
  68         Ticks scheduled_date;              ///< The date this departure is scheduled to finish on (i.e. when the vehicle leaves the station)
  69         Ticks lateness;                    ///< How delayed the departure is expected to be
  70         CallAt terminus;                    ///< The station at which the vehicle will terminate following this departure
  71         StationID via;                         ///< The station the departure should list as going via
  72         SmallVector<CallAt, 32> calling_at; ///< The stations both called at and unloaded at by the vehicle after this departure before it terminates
  73         DepartureStatus status;                ///< Whether the vehicle has arrived yet for this departure
  74         DepartureType type;                    ///< The type of the departure (departure or arrival)
  75         VehicleID vehicle;                ///< The vehicle performing this departure
  76         OrderID order;                    ///< The order corresponding to this departure
  77         Departure() : terminus(INVALID_STATION), via(INVALID_STATION), calling_at(), vehicle(INVALID_VEHICLE), order(INVALID_ORDER) { }
  78         ~Departure()
  79         {
  80                 calling_at.Reset();
  81         }
  82
  83     inline bool operator==(const Departure& d) const {
  84         if (this->calling_at.Length() != d.calling_at.Length()) return false;
  85
  86         for (uint i = 0; i < this->calling_at.Length(); ++i) {
  87             if (*(this->calling_at.Get(i)) != *(d.calling_at.Get(i))) return false;
  88         }
  89
  90         return
  91             this->scheduled_date == d.scheduled_date &&
  92             this->vehicle == d.vehicle &&
  93             this->via == d.via &&
  94             this->type == d.type
  95             ;
  96     }
  97 } Departure;
  98
  99 typedef SmallVector<Departure*, 32> DepartureList;
 100
 101 #endif /* DEPARTURES_TYPE_H */