src/station_type.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 station_type.h Types related to stations. */
  11
  12 #ifndef STATION_TYPE_H
  13 #define STATION_TYPE_H
  14
  15 #include "core/smallvec_type.hpp"
  16 #include "map/tilearea.h"
  17 #include <list>
  18 #include <deque>
  19
  20 typedef uint16 StationID;
  21 typedef uint16 RoadStopID;
  22 typedef uint16 DockID;
  23
  24 struct BaseStation;
  25 struct Station;
  26 struct RoadStop;
  27 struct StationSpec;
  28 struct Waypoint;
  29
  30 static const StationID INVALID_STATION = 0xFFFF;
  31
  32 struct StationIDStack : std::deque<StationID> {
  33         /** Check if the stack contains a given element. */
  34         bool Contains (StationID id) const
  35         {
  36                 for (const_iterator iter (begin()); iter != end(); iter++) {
  37                         if (*iter == id) return true;
  38                 }
  39                 return false;
  40         }
  41 };
  42
  43 /** Station types */
  44 enum StationType {
  45         STATION_RAIL,
  46         STATION_AIRPORT,
  47         STATION_TRUCK,
  48         STATION_BUS,
  49         STATION_OILRIG,
  50         STATION_DOCK,
  51         STATION_BUOY,
  52         STATION_WAYPOINT,
  53 };
  54
  55 /** Types of RoadStops */
  56 enum RoadStopType {
  57         ROADSTOP_BUS,    ///< A standard stop for buses
  58         ROADSTOP_TRUCK,  ///< A standard stop for trucks
  59 };
  60
  61 /** The facilities a station might be having */
  62 enum StationFacility {
  63         FACIL_NONE       = 0,      ///< The station has no facilities at all
  64         FACIL_TRAIN      = 1 << 0, ///< Station with train station
  65         FACIL_TRUCK_STOP = 1 << 1, ///< Station with truck stops
  66         FACIL_BUS_STOP   = 1 << 2, ///< Station with bus stops
  67         FACIL_AIRPORT    = 1 << 3, ///< Station with an airport
  68         FACIL_DOCK       = 1 << 4, ///< Station with a dock
  69         FACIL_WAYPOINT   = 1 << 7, ///< Station is a waypoint
  70 };
  71 DECLARE_ENUM_AS_BIT_SET(StationFacility)
  72 typedef SimpleTinyEnumT<StationFacility, byte> StationFacilityByte;
  73
  74 /** The vehicles that may have visited a station */
  75 enum StationHadVehicleOfType {
  76         HVOT_NONE     = 0,      ///< Station has seen no vehicles
  77         HVOT_TRAIN    = 1 << 1, ///< Station has seen a train
  78         HVOT_BUS      = 1 << 2, ///< Station has seen a bus
  79         HVOT_TRUCK    = 1 << 3, ///< Station has seen a truck
  80         HVOT_AIRCRAFT = 1 << 4, ///< Station has seen an aircraft
  81         HVOT_SHIP     = 1 << 5, ///< Station has seen a ship
  82
  83         HVOT_WAYPOINT = 1 << 6, ///< Station is a waypoint (NewGRF only!)
  84 };
  85 DECLARE_ENUM_AS_BIT_SET(StationHadVehicleOfType)
  86 typedef SimpleTinyEnumT<StationHadVehicleOfType, byte> StationHadVehicleOfTypeByte;
  87
  88 /** The different catchment areas used */
  89 enum CatchmentArea {
  90         CA_NONE            =  0, ///< Catchment when the station has no facilities
  91         CA_BUS             =  3, ///< Catchment for bus stops with "modified catchment" enabled
  92         CA_TRUCK           =  3, ///< Catchment for truck stops with "modified catchment" enabled
  93         CA_TRAIN           =  4, ///< Catchment for train stations with "modified catchment" enabled
  94         CA_DOCK            =  5, ///< Catchment for docks with "modified catchment" enabled
  95
  96         CA_UNMODIFIED      =  4, ///< Catchment for all stations with "modified catchment" disabled
  97
  98         MAX_CATCHMENT      = 10, ///< Maximum catchment for airports with "modified catchment" enabled
  99 };
 100
 101 static const uint MAX_LENGTH_STATION_NAME_CHARS = 32; ///< The maximum length of a station name in characters including '\0'
 102
 103 /** List of station IDs */
 104 typedef std::list<StationID> StationIDList;
 105
 106 /** List of stations */
 107 typedef SmallVector<Station *, 2> StationList;
 108
 109 /**
 110  * Structure contains cached list of stations nearby. The list
 111  * is created upon first call to GetStations()
 112  */
 113 class StationFinder : TileArea {
 114         StationList stations; ///< List of stations nearby
 115 public:
 116         /**
 117          * Constructs StationFinder
 118          * @param area the area to search from
 119          */
 120         StationFinder(const TileArea &area) : TileArea(area) {}
 121         const StationList *GetStations();
 122 };
 123
 124 #endif /* STATION_TYPE_H */