OpenTTD Source: src/station_type.h Source File

OpenTTD Source 1.11.0-RC1

station_type.h
Go to the documentation of this file.
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 */
7
10 #ifndef STATION_TYPE_H
11 #define STATION_TYPE_H
12
13 #include "core/smallstack_type.hpp"
14 #include "tilearea_type.h"
15 #include <set>
16
17 typedef uint16 StationID;
18 typedef uint16 RoadStopID;
19
20 struct BaseStation;
21 struct Station;
22 struct RoadStop;
23 struct StationSpec;
24 struct Waypoint;
25
26 static const StationID NEW_STATION = 0xFFFE;
27 static const StationID INVALID_STATION = 0xFFFF;
28
29 typedef SmallStack<StationID, StationID, INVALID_STATION, 8, 0xFFFD> StationIDStack;
30
32 enum StationType {
33 STATION_RAIL,
34 STATION_AIRPORT,
35 STATION_TRUCK,
36 STATION_BUS,
37 STATION_OILRIG,
38 STATION_DOCK,
39 STATION_BUOY,
40 STATION_WAYPOINT,
41 };
42
44 enum RoadStopType {
45 ROADSTOP_BUS,
46 ROADSTOP_TRUCK,
47 };
48
50 enum StationFacility : byte {
51 FACIL_NONE = 0,
52 FACIL_TRAIN = 1 << 0,
53 FACIL_TRUCK_STOP = 1 << 1,
54 FACIL_BUS_STOP = 1 << 2,
55 FACIL_AIRPORT = 1 << 3,
56 FACIL_DOCK = 1 << 4,
57 FACIL_WAYPOINT = 1 << 7,
58 };
59 DECLARE_ENUM_AS_BIT_SET(StationFacility)
60
61
62 enum StationHadVehicleOfType : byte {
63 HVOT_NONE = 0,
64 HVOT_TRAIN = 1 << 1,
65 HVOT_BUS = 1 << 2,
66 HVOT_TRUCK = 1 << 3,
67 HVOT_AIRCRAFT = 1 << 4,
68 HVOT_SHIP = 1 << 5,
69
70 HVOT_WAYPOINT = 1 << 6,
71 };
72 DECLARE_ENUM_AS_BIT_SET(StationHadVehicleOfType)
73
74
75 enum CatchmentArea {
76 CA_NONE = 0,
77 CA_BUS = 3,
78 CA_TRUCK = 3,
79 CA_TRAIN = 4,
80 CA_DOCK = 5,
81
82 CA_UNMODIFIED = 4,
83
84 MAX_CATCHMENT = 10,
85 };
86
87 static const uint MAX_LENGTH_STATION_NAME_CHARS = 32;
88
89 struct StationCompare {
90 bool operator() (const Station *lhs, const Station *rhs) const;
91 };
92
94 typedef std::set<Station *, StationCompare> StationList;
95
100 class StationFinder : TileArea {
101 StationList stations;
102 public:
107 StationFinder(const TileArea &area) : TileArea(area) {}
108 const StationList *GetStations();
109 };
110
111 #endif /* STATION_TYPE_H */
CA_UNMODIFIED
@ CA_UNMODIFIED
Catchment for all stations with "modified catchment" disabled.
Definition: station_type.h:82
SmallStack
Minimal stack that uses a pool to avoid pointers.
Definition: smallstack_type.hpp:136
StationFinder
Structure contains cached list of stations nearby.
Definition: station_type.h:100
HVOT_NONE
@ HVOT_NONE
Station has seen no vehicles.
Definition: station_type.h:63
CA_NONE
@ CA_NONE
Catchment when the station has no facilities.
Definition: station_type.h:76
FACIL_TRUCK_STOP
@ FACIL_TRUCK_STOP
Station with truck stops.
Definition: station_type.h:53
Station
Station data structure.
Definition: station_base.h:450
Waypoint
Representation of a waypoint.
Definition: waypoint_base.h:16
FACIL_NONE
@ FACIL_NONE
The station has no facilities at all.
Definition: station_type.h:51
ROADSTOP_BUS
@ ROADSTOP_BUS
A standard stop for buses.
Definition: station_type.h:45
StationType
StationType
Station types.
Definition: station_type.h:32
MAX_CATCHMENT
@ MAX_CATCHMENT
Maximum catchment for airports with "modified catchment" enabled.
Definition: station_type.h:84
FACIL_BUS_STOP
@ FACIL_BUS_STOP
Station with bus stops.
Definition: station_type.h:54
StationFinder::stations
StationList stations
List of stations nearby.
Definition: station_type.h:101
HVOT_WAYPOINT
@ HVOT_WAYPOINT
Station is a waypoint (NewGRF only!)
Definition: station_type.h:70
HVOT_TRUCK
@ HVOT_TRUCK
Station has seen a truck.
Definition: station_type.h:66
OrthogonalTileArea
Represents the covered area of e.g.
Definition: tilearea_type.h:16
HVOT_TRAIN
@ HVOT_TRAIN
Station has seen a train.
Definition: station_type.h:64
HVOT_SHIP
@ HVOT_SHIP
Station has seen a ship.
Definition: station_type.h:68
CA_BUS
@ CA_BUS
Catchment for bus stops with "modified catchment" enabled.
Definition: station_type.h:77
ROADSTOP_TRUCK
@ ROADSTOP_TRUCK
A standard stop for trucks.
Definition: station_type.h:46
CA_TRUCK
@ CA_TRUCK
Catchment for truck stops with "modified catchment" enabled.
Definition: station_type.h:78
HVOT_AIRCRAFT
@ HVOT_AIRCRAFT
Station has seen an aircraft.
Definition: station_type.h:67
FACIL_DOCK
@ FACIL_DOCK
Station with a dock.
Definition: station_type.h:56
StationFinder::GetStations
const StationList * GetStations()
Run a tile loop to find stations around a tile, on demand.
Definition: station_cmd.cpp:3979
StationList
std::set< Station *, StationCompare > StationList
List of stations.
Definition: station_type.h:94
StationFacility
StationFacility
The facilities a station might be having.
Definition: station_type.h:50
FACIL_WAYPOINT
@ FACIL_WAYPOINT
Station is a waypoint.
Definition: station_type.h:57
CA_DOCK
@ CA_DOCK
Catchment for docks with "modified catchment" enabled.
Definition: station_type.h:80
MAX_LENGTH_STATION_NAME_CHARS
static const uint MAX_LENGTH_STATION_NAME_CHARS
The maximum length of a station name in characters including '\0'.
Definition: station_type.h:87
tilearea_type.h
StationSpec
Station specification.
Definition: newgrf_station.h:117
FACIL_TRAIN
@ FACIL_TRAIN
Station with train station.
Definition: station_type.h:52
RoadStopType
RoadStopType
Types of RoadStops.
Definition: station_type.h:44
BaseStation
Base class for all station-ish types.
Definition: base_station_base.h:52
DECLARE_ENUM_AS_BIT_SET
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Definition: company_manager_face.h:29
CA_TRAIN
@ CA_TRAIN
Catchment for train stations with "modified catchment" enabled.
Definition: station_type.h:79
StationHadVehicleOfType
StationHadVehicleOfType
The vehicles that may have visited a station.
Definition: station_type.h:62
RoadStop
A Stop for a Road Vehicle.
Definition: roadstop_base.h:22
smallstack_type.hpp
FACIL_AIRPORT
@ FACIL_AIRPORT
Station with an airport.
Definition: station_type.h:55
CatchmentArea
CatchmentArea
The different catchment areas used.
Definition: station_type.h:75
HVOT_BUS
@ HVOT_BUS
Station has seen a bus.
Definition: station_type.h:65
StationCompare
Definition: station_type.h:89
StationFinder::StationFinder
StationFinder(const TileArea &area)
Constructs StationFinder.
Definition: station_type.h:107