Codechange: Use CargoArray for linkgraph refresher. (#13165)
[openttd-github.git] / src / station_type.h
blobbec8bcbae6b8e7dbae466c87264367d66aca43f7
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 */
8 /** @file station_type.h Types related to stations. */
10 #ifndef STATION_TYPE_H
11 #define STATION_TYPE_H
13 #include "core/smallstack_type.hpp"
14 #include "tilearea_type.h"
16 typedef uint16_t StationID;
17 typedef uint16_t RoadStopID;
19 struct BaseStation;
20 struct Station;
21 struct RoadStop;
22 struct StationSpec;
23 struct Waypoint;
25 static const StationID NEW_STATION = 0xFFFE;
26 static const StationID INVALID_STATION = 0xFFFF;
28 typedef SmallStack<StationID, StationID, INVALID_STATION, 8, 0xFFFD> StationIDStack;
30 /** Station types */
31 enum StationType : uint8_t {
32 STATION_RAIL,
33 STATION_AIRPORT,
34 STATION_TRUCK,
35 STATION_BUS,
36 STATION_OILRIG,
37 STATION_DOCK,
38 STATION_BUOY,
39 STATION_WAYPOINT,
40 STATION_ROADWAYPOINT,
41 STATION_END,
44 /** Types of RoadStops */
45 enum RoadStopType : uint8_t {
46 ROADSTOP_BUS, ///< A standard stop for buses
47 ROADSTOP_TRUCK, ///< A standard stop for trucks
48 ROADSTOP_END, ///< End of valid types
51 /** The facilities a station might be having */
52 enum StationFacility : uint8_t {
53 FACIL_NONE = 0, ///< The station has no facilities at all
54 FACIL_TRAIN = 1 << 0, ///< Station with train station
55 FACIL_TRUCK_STOP = 1 << 1, ///< Station with truck stops
56 FACIL_BUS_STOP = 1 << 2, ///< Station with bus stops
57 FACIL_AIRPORT = 1 << 3, ///< Station with an airport
58 FACIL_DOCK = 1 << 4, ///< Station with a dock
59 FACIL_WAYPOINT = 1 << 7, ///< Station is a waypoint
61 DECLARE_ENUM_AS_BIT_SET(StationFacility)
63 /** The vehicles that may have visited a station */
64 enum StationHadVehicleOfType : uint8_t {
65 HVOT_NONE = 0, ///< Station has seen no vehicles
66 HVOT_TRAIN = 1 << 1, ///< Station has seen a train
67 HVOT_BUS = 1 << 2, ///< Station has seen a bus
68 HVOT_TRUCK = 1 << 3, ///< Station has seen a truck
69 HVOT_AIRCRAFT = 1 << 4, ///< Station has seen an aircraft
70 HVOT_SHIP = 1 << 5, ///< Station has seen a ship
72 HVOT_WAYPOINT = 1 << 6, ///< Station is a waypoint (NewGRF only!)
74 DECLARE_ENUM_AS_BIT_SET(StationHadVehicleOfType)
76 /* The different catchment area sizes. */
77 static constexpr uint CA_NONE = 0; ///< Catchment when the station has no facilities
78 static constexpr uint CA_BUS = 3; ///< Catchment for bus stops with "modified catchment" enabled
79 static constexpr uint CA_TRUCK = 3; ///< Catchment for truck stops with "modified catchment" enabled
80 static constexpr uint CA_TRAIN = 4; ///< Catchment for train stations with "modified catchment" enabled
81 static constexpr uint CA_DOCK = 5; ///< Catchment for docks with "modified catchment" enabled
83 static constexpr uint CA_UNMODIFIED = 4; ///< Catchment for all stations with "modified catchment" disabled
85 static constexpr uint MAX_CATCHMENT = 10; ///< Maximum catchment for airports with "modified catchment" enabled
87 static const uint MAX_LENGTH_STATION_NAME_CHARS = 32; ///< The maximum length of a station name in characters including '\0'
89 struct StationCompare {
90 bool operator() (const Station *lhs, const Station *rhs) const;
93 /** List of stations */
94 typedef std::set<Station *, StationCompare> StationList;
96 /**
97 * Structure contains cached list of stations nearby. The list
98 * is created upon first call to GetStations()
100 class StationFinder : TileArea {
101 StationList stations; ///< List of stations nearby
102 public:
104 * Constructs StationFinder
105 * @param area the area to search from
107 StationFinder(const TileArea &area) : TileArea(area) {}
108 const StationList &GetStations();
111 #endif /* STATION_TYPE_H */