Files
@ r22020:8b70c8695a6c
Branch filter:
Location: cpp/openttd-patchpack/source/src/station_base.h
r22020:8b70c8695a6c
17.2 KiB
text/x-c
(svn r27177) -Update from WebTranslator v3.0:
catalan - 3 changes by juanjo
dutch - 4 changes by habell
russian - 4 changes by Lone_Wolf
spanish - 10 changes by juanjo
tamil - 7 changes by ganesh
catalan - 3 changes by juanjo
dutch - 4 changes by habell
russian - 4 changes by Lone_Wolf
spanish - 10 changes by juanjo
tamil - 7 changes by ganesh
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 | /* $Id$ */
/*
* 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 station_base.h Base classes/functions for stations. */
#ifndef STATION_BASE_H
#define STATION_BASE_H
#include "core/random_func.hpp"
#include "base_station_base.h"
#include "newgrf_airport.h"
#include "cargopacket.h"
#include "industry_type.h"
#include "linkgraph/linkgraph_type.h"
#include "newgrf_storage.h"
#include <map>
typedef Pool<BaseStation, StationID, 32, 64000> StationPool;
extern StationPool _station_pool;
static const byte INITIAL_STATION_RATING = 175;
/**
* Flow statistics telling how much flow should be sent along a link. This is
* done by creating "flow shares" and using std::map's upper_bound() method to
* look them up with a random number. A flow share is the difference between a
* key in a map and the previous key. So one key in the map doesn't actually
* mean anything by itself.
*/
class FlowStat {
public:
typedef std::map<uint32, StationID> SharesMap;
/**
* Invalid constructor. This can't be called as a FlowStat must not be
* empty. However, the constructor must be defined and reachable for
* FlwoStat to be used in a std::map.
*/
inline FlowStat() {NOT_REACHED();}
/**
* Create a FlowStat with an initial entry.
* @param st Station the initial entry refers to.
* @param flow Amount of flow for the initial entry.
* @param restricted If the flow to be added is restricted.
*/
inline FlowStat(StationID st, uint flow, bool restricted = false)
{
assert(flow > 0);
this->shares[flow] = st;
this->unrestricted = restricted ? 0 : flow;
}
/**
* Add some flow to the end of the shares map. Only do that if you know
* that the station isn't in the map yet. Anything else may lead to
* inconsistencies.
* @param st Remote station.
* @param flow Amount of flow to be added.
* @param restricted If the flow to be added is restricted.
*/
inline void AppendShare(StationID st, uint flow, bool restricted = false)
{
assert(flow > 0);
this->shares[(--this->shares.end())->first + flow] = st;
if (!restricted) this->unrestricted += flow;
}
uint GetShare(StationID st) const;
void ChangeShare(StationID st, int flow);
void RestrictShare(StationID st);
void ReleaseShare(StationID st);
void ScaleToMonthly(uint runtime);
/**
* Get the actual shares as a const pointer so that they can be iterated
* over.
* @return Actual shares.
*/
inline const SharesMap *GetShares() const { return &this->shares; }
/**
* Return total amount of unrestricted shares.
* @return Amount of unrestricted shares.
*/
inline uint GetUnrestricted() const { return this->unrestricted; }
/**
* Swap the shares maps, and thus the content of this FlowStat with the
* other one.
* @param other FlowStat to swap with.
*/
inline void SwapShares(FlowStat &other)
{
this->shares.swap(other.shares);
Swap(this->unrestricted, other.unrestricted);
}
/**
* Get a station a package can be routed to. This done by drawing a
* random number between 0 and sum_shares and then looking that up in
* the map with lower_bound. So each share gets selected with a
* probability dependent on its flow. Do include restricted flows here.
* @param is_restricted Output if a restricted flow was chosen.
* @return A station ID from the shares map.
*/
inline StationID GetViaWithRestricted(bool &is_restricted) const
{
assert(!this->shares.empty());
uint rand = RandomRange((--this->shares.end())->first);
is_restricted = rand >= this->unrestricted;
return this->shares.upper_bound(rand)->second;
}
/**
* Get a station a package can be routed to. This done by drawing a
* random number between 0 and sum_shares and then looking that up in
* the map with lower_bound. So each share gets selected with a
* probability dependent on its flow. Don't include restricted flows.
* @return A station ID from the shares map.
*/
inline StationID GetVia() const
{
assert(!this->shares.empty());
return this->unrestricted > 0 ?
this->shares.upper_bound(RandomRange(this->unrestricted))->second :
INVALID_STATION;
}
StationID GetVia(StationID excluded, StationID excluded2 = INVALID_STATION) const;
void Invalidate();
private:
SharesMap shares; ///< Shares of flow to be sent via specified station (or consumed locally).
uint unrestricted; ///< Limit for unrestricted shares.
};
/** Flow descriptions by origin stations. */
class FlowStatMap : public std::map<StationID, FlowStat> {
public:
uint GetFlow() const;
uint GetFlowVia(StationID via) const;
uint GetFlowFrom(StationID from) const;
uint GetFlowFromVia(StationID from, StationID via) const;
void AddFlow(StationID origin, StationID via, uint amount);
void PassOnFlow(StationID origin, StationID via, uint amount);
StationIDStack DeleteFlows(StationID via);
void RestrictFlows(StationID via);
void ReleaseFlows(StationID via);
void FinalizeLocalConsumption(StationID self);
};
/**
* Stores station stats for a single cargo.
*/
struct GoodsEntry {
/** Status of this cargo for the station. */
enum GoodsEntryStatus {
/**
* Set when the station accepts the cargo currently for final deliveries.
* It is updated every STATION_ACCEPTANCE_TICKS ticks by checking surrounding tiles for acceptance >= 8/8.
*/
GES_ACCEPTANCE,
/**
* This indicates whether a cargo has a rating at the station.
* Set when cargo was ever waiting at the station.
* It is set when cargo supplied by surrounding tiles is moved to the station, or when
* arriving vehicles unload/transfer cargo without it being a final delivery.
*
* This flag is cleared after 255 * STATION_RATING_TICKS of not having seen a pickup.
*/
GES_RATING,
/**
* Set when a vehicle ever delivered cargo to the station for final delivery.
* This flag is never cleared.
*/
GES_EVER_ACCEPTED,
/**
* Set when cargo was delivered for final delivery last month.
* This flag is set to the value of GES_CURRENT_MONTH at the start of each month.
*/
GES_LAST_MONTH,
/**
* Set when cargo was delivered for final delivery this month.
* This flag is reset on the beginning of every month.
*/
GES_CURRENT_MONTH,
/**
* Set when cargo was delivered for final delivery during the current STATION_ACCEPTANCE_TICKS interval.
* This flag is reset every STATION_ACCEPTANCE_TICKS ticks.
*/
GES_ACCEPTED_BIGTICK,
};
GoodsEntry() :
status(0),
time_since_pickup(255),
rating(INITIAL_STATION_RATING),
last_speed(0),
last_age(255),
amount_fract(0),
link_graph(INVALID_LINK_GRAPH),
node(INVALID_NODE),
max_waiting_cargo(0)
{}
byte status; ///< Status of this cargo, see #GoodsEntryStatus.
/**
* Number of rating-intervals (up to 255) since the last vehicle tried to load this cargo.
* The unit used is STATION_RATING_TICKS.
* This does not imply there was any cargo to load.
*/
byte time_since_pickup;
byte rating; ///< %Station rating for this cargo.
/**
* Maximum speed (up to 255) of the last vehicle that tried to load this cargo.
* This does not imply there was any cargo to load.
* The unit used is a special vehicle-specific speed unit for station ratings.
* - Trains: km-ish/h
* - RV: km-ish/h
* - Ships: 0.5 * km-ish/h
* - Aircraft: 8 * mph
*/
byte last_speed;
/**
* Age in years (up to 255) of the last vehicle that tried to load this cargo.
* This does not imply there was any cargo to load.
*/
byte last_age;
byte amount_fract; ///< Fractional part of the amount in the cargo list
StationCargoList cargo; ///< The cargo packets of cargo waiting in this station
LinkGraphID link_graph; ///< Link graph this station belongs to.
NodeID node; ///< ID of node in link graph referring to this goods entry.
FlowStatMap flows; ///< Planned flows through this station.
uint max_waiting_cargo; ///< Max cargo from this station waiting at any station.
/**
* Reports whether a vehicle has ever tried to load the cargo at this station.
* This does not imply that there was cargo available for loading. Refer to GES_RATING for that.
* @return true if vehicle tried to load.
*/
bool HasVehicleEverTriedLoading() const { return this->last_speed != 0; }
/**
* Does this cargo have a rating at this station?
* @return true if the cargo has a rating, i.e. cargo has been moved to the station.
*/
inline bool HasRating() const
{
return HasBit(this->status, GES_RATING);
}
/**
* Get the best next hop for a cargo packet from station source.
* @param source Source of the packet.
* @return The chosen next hop or INVALID_STATION if none was found.
*/
inline StationID GetVia(StationID source) const
{
FlowStatMap::const_iterator flow_it(this->flows.find(source));
return flow_it != this->flows.end() ? flow_it->second.GetVia() : INVALID_STATION;
}
/**
* Get the best next hop for a cargo packet from station source, optionally
* excluding one or two stations.
* @param source Source of the packet.
* @param excluded If this station would be chosen choose the second best one instead.
* @param excluded2 Second station to be excluded, if != INVALID_STATION.
* @return The chosen next hop or INVALID_STATION if none was found.
*/
inline StationID GetVia(StationID source, StationID excluded, StationID excluded2 = INVALID_STATION) const
{
FlowStatMap::const_iterator flow_it(this->flows.find(source));
return flow_it != this->flows.end() ? flow_it->second.GetVia(excluded, excluded2) : INVALID_STATION;
}
};
/** All airport-related information. Only valid if tile != INVALID_TILE. */
struct Airport : public TileArea {
Airport() : TileArea(INVALID_TILE, 0, 0) {}
uint64 flags; ///< stores which blocks on the airport are taken. was 16 bit earlier on, then 32
byte type; ///< Type of this airport, @see AirportTypes
byte layout; ///< Airport layout number.
DirectionByte rotation; ///< How this airport is rotated.
PersistentStorage *psa; ///< Persistent storage for NewGRF airports.
/**
* Get the AirportSpec that from the airport type of this airport. If there
* is no airport (\c tile == INVALID_TILE) then return the dummy AirportSpec.
* @return The AirportSpec for this airport.
*/
const AirportSpec *GetSpec() const
{
if (this->tile == INVALID_TILE) return &AirportSpec::dummy;
return AirportSpec::Get(this->type);
}
/**
* Get the finite-state machine for this airport or the finite-state machine
* for the dummy airport in case this isn't an airport.
* @pre this->type < NEW_AIRPORT_OFFSET.
* @return The state machine for this airport.
*/
const AirportFTAClass *GetFTA() const
{
return this->GetSpec()->fsm;
}
/** Check if this airport has at least one hangar. */
inline bool HasHangar() const
{
return this->GetSpec()->nof_depots > 0;
}
/**
* Add the tileoffset to the base tile of this airport but rotate it first.
* The base tile is the northernmost tile of this airport. This function
* helps to make sure that getting the tile of a hangar works even for
* rotated airport layouts without requiring a rotated array of hangar tiles.
* @param tidc The tilediff to add to the airport tile.
* @return The tile of this airport plus the rotated offset.
*/
inline TileIndex GetRotatedTileFromOffset(TileIndexDiffC tidc) const
{
const AirportSpec *as = this->GetSpec();
switch (this->rotation) {
case DIR_N: return this->tile + ToTileIndexDiff(tidc);
case DIR_E: return this->tile + TileDiffXY(tidc.y, as->size_x - 1 - tidc.x);
case DIR_S: return this->tile + TileDiffXY(as->size_x - 1 - tidc.x, as->size_y - 1 - tidc.y);
case DIR_W: return this->tile + TileDiffXY(as->size_y - 1 - tidc.y, tidc.x);
default: NOT_REACHED();
}
}
/**
* Get the first tile of the given hangar.
* @param hangar_num The hangar to get the location of.
* @pre hangar_num < GetNumHangars().
* @return A tile with the given hangar.
*/
inline TileIndex GetHangarTile(uint hangar_num) const
{
const AirportSpec *as = this->GetSpec();
for (uint i = 0; i < as->nof_depots; i++) {
if (as->depot_table[i].hangar_num == hangar_num) {
return this->GetRotatedTileFromOffset(as->depot_table[i].ti);
}
}
NOT_REACHED();
}
/**
* Get the exit direction of the hangar at a specific tile.
* @param tile The tile to query.
* @pre IsHangarTile(tile).
* @return The exit direction of the hangar, taking airport rotation into account.
*/
inline Direction GetHangarExitDirection(TileIndex tile) const
{
const AirportSpec *as = this->GetSpec();
const HangarTileTable *htt = GetHangarDataByTile(tile);
return ChangeDir(htt->dir, DirDifference(this->rotation, as->rotation[0]));
}
/**
* Get the hangar number of the hangar at a specific tile.
* @param tile The tile to query.
* @pre IsHangarTile(tile).
* @return The hangar number of the hangar at the given tile.
*/
inline uint GetHangarNum(TileIndex tile) const
{
const HangarTileTable *htt = GetHangarDataByTile(tile);
return htt->hangar_num;
}
/** Get the number of hangars on this airport. */
inline uint GetNumHangars() const
{
uint num = 0;
uint counted = 0;
const AirportSpec *as = this->GetSpec();
for (uint i = 0; i < as->nof_depots; i++) {
if (!HasBit(counted, as->depot_table[i].hangar_num)) {
num++;
SetBit(counted, as->depot_table[i].hangar_num);
}
}
return num;
}
private:
/**
* Retrieve hangar information of a hangar at a given tile.
* @param tile %Tile containing the hangar.
* @return The requested hangar information.
* @pre The \a tile must be at a hangar tile at an airport.
*/
inline const HangarTileTable *GetHangarDataByTile(TileIndex tile) const
{
const AirportSpec *as = this->GetSpec();
for (uint i = 0; i < as->nof_depots; i++) {
if (this->GetRotatedTileFromOffset(as->depot_table[i].ti) == tile) {
return as->depot_table + i;
}
}
NOT_REACHED();
}
};
typedef SmallVector<Industry *, 2> IndustryVector;
/** Station data structure */
struct Station FINAL : SpecializedStation<Station, false> {
public:
RoadStop *GetPrimaryRoadStop(RoadStopType type) const
{
return type == ROADSTOP_BUS ? bus_stops : truck_stops;
}
RoadStop *GetPrimaryRoadStop(const struct RoadVehicle *v) const;
RoadStop *bus_stops; ///< All the road stops
TileArea bus_station; ///< Tile area the bus 'station' part covers
RoadStop *truck_stops; ///< All the truck stops
TileArea truck_station; ///< Tile area the truck 'station' part covers
Airport airport; ///< Tile area the airport covers
TileIndex dock_tile; ///< The location of the dock
IndustryType indtype; ///< Industry type to get the name from
StationHadVehicleOfTypeByte had_vehicle_of_type;
byte time_since_load;
byte time_since_unload;
byte last_vehicle_type;
std::list<Vehicle *> loading_vehicles;
GoodsEntry goods[NUM_CARGO]; ///< Goods at this station
uint32 always_accepted; ///< Bitmask of always accepted cargo types (by houses, HQs, industry tiles when industry doesn't accept cargo)
IndustryVector industries_near; ///< Cached list of industries near the station that can accept cargo, @see DeliverGoodsToIndustry()
Station(TileIndex tile = INVALID_TILE);
~Station();
void AddFacility(StationFacility new_facility_bit, TileIndex facil_xy);
void MarkTilesDirty(bool cargo_change) const;
void UpdateVirtCoord();
/* virtual */ uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;
/* virtual */ uint GetPlatformLength(TileIndex tile) const;
void RecomputeIndustriesNear();
static void RecomputeIndustriesNearForAll();
uint GetCatchmentRadius() const;
Rect GetCatchmentRect() const;
/* virtual */ inline bool TileBelongsToRailStation(TileIndex tile) const
{
return IsRailStationTile(tile) && GetStationIndex(tile) == this->index;
}
inline bool TileBelongsToAirport(TileIndex tile) const
{
return IsAirportTile(tile) && GetStationIndex(tile) == this->index;
}
/* virtual */ uint32 GetNewGRFVariable(const ResolverObject &object, byte variable, byte parameter, bool *available) const;
/* virtual */ void GetTileArea(TileArea *ta, StationType type) const;
};
#define FOR_ALL_STATIONS(var) FOR_ALL_BASE_STATIONS_OF_TYPE(Station, var)
/** Iterator to iterate over all tiles belonging to an airport. */
class AirportTileIterator : public OrthogonalTileIterator {
private:
const Station *st; ///< The station the airport is a part of.
public:
/**
* Construct the iterator.
* @param ta Area, i.e. begin point and width/height of to-be-iterated area.
*/
AirportTileIterator(const Station *st) : OrthogonalTileIterator(st->airport), st(st)
{
if (!st->TileBelongsToAirport(this->tile)) ++(*this);
}
inline TileIterator& operator ++()
{
(*this).OrthogonalTileIterator::operator++();
while (this->tile != INVALID_TILE && !st->TileBelongsToAirport(this->tile)) {
(*this).OrthogonalTileIterator::operator++();
}
return *this;
}
virtual TileIterator *Clone() const
{
return new AirportTileIterator(*this);
}
};
#endif /* STATION_BASE_H */
|