From 1d11291071d41712b61983f195f1ba21d9c7ebcb Mon Sep 17 00:00:00 2001 From: alberth Date: Sun, 15 Jul 2012 17:05:17 +0000 Subject: (svn r24404) -Add: Data structures for cargo transport monitoring. --- src/cargomonitor.h | 148 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 148 insertions(+) create mode 100644 src/cargomonitor.h (limited to 'src/cargomonitor.h') diff --git a/src/cargomonitor.h b/src/cargomonitor.h new file mode 100644 index 000000000..1c7123b77 --- /dev/null +++ b/src/cargomonitor.h @@ -0,0 +1,148 @@ +/* $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 . + */ + +/** @file cargomonitor.h Cargo transport monitoring declarations. */ + +#ifndef CARGOMONITOR_H +#define CARGOMONITOR_H + +#include "cargo_type.h" +#include "company_func.h" +#include "industry.h" +#include "town.h" +#include + +struct Station; + +/** + * Unique number for a company / cargo type / (town or industry). + * Encoding is as follows: + * - bits 0-15 town or industry number + * - bit 16 is set if it is an industry number (else it is a town number). + * - bits 19-23 Cargo type. + * - bits 24-31 %Company number. + */ +typedef uint32 CargoMonitorID; ///< Type of the cargo monitor number. + +/** Map type for storing and updating active cargo monitor numbers and their amounts. */ +typedef std::map CargoMonitorMap; + +extern CargoMonitorMap _cargo_pickups; +extern CargoMonitorMap _cargo_deliveries; + + +/** Constants for encoding and extracting cargo monitors. */ +enum CargoCompanyBits { + CCB_TOWN_IND_NUMBER_START = 0, ///< Start bit of the town or industry number. + CCB_TOWN_IND_NUMBER_LENGTH = 16, ///< Number of bits of the town or industry number. + CCB_IS_INDUSTRY_BIT = 16, ///< Bit indicating the town/industry number is an industry. + CCB_IS_INDUSTRY_BIT_VALUE = 1ul << CCB_IS_INDUSTRY_BIT, ///< Value of the #CCB_IS_INDUSTRY_BIT bit. + CCB_CARGO_TYPE_START = 19, ///< Start bit of the cargo type field. + CCB_CARGO_TYPE_LENGTH = 5, ///< Number of bits of the cargo type field. + CCB_COMPANY_START = 24, ///< Start bit of the company field. + CCB_COMPANY_LENGTH = 8, ///< Number of bits of the company field. +}; + + +/** + * Encode a cargo monitor for pickup or delivery at an industry. + * @param company Company performing the transport. + * @param ctype Cargo type being transported. + * @param ind %Industry providing or accepting the cargo. + * @return The encoded cargo/company/industry number. + */ +static inline CargoMonitorID EncodeCargoIndustryMonitor(CompanyID company, CargoID ctype, IndustryID ind) +{ + assert(ctype < (1 << CCB_CARGO_TYPE_LENGTH)); + + uint32 ret = 0; + SB(ret, CCB_TOWN_IND_NUMBER_START, CCB_TOWN_IND_NUMBER_LENGTH, ind); + SetBit(ret, CCB_IS_INDUSTRY_BIT); + SB(ret, CCB_CARGO_TYPE_START, CCB_CARGO_TYPE_LENGTH, ctype); + SB(ret, CCB_COMPANY_START, CCB_COMPANY_LENGTH, company); + return ret; +} + +/** + * Encode a cargo monitoring number for pickup or delivery at a town. + * @param company %Company performing the transport. + * @param ctype Cargo type being transported. + * @param town %Town providing or accepting the cargo. + * @return The encoded cargo/company/town number. + */ +static inline CargoMonitorID EncodeCargoTownMonitor(CompanyID company, CargoID ctype, TownID town) +{ + assert(ctype < (1 << CCB_CARGO_TYPE_LENGTH)); + + uint32 ret = 0; + SB(ret, CCB_TOWN_IND_NUMBER_START, CCB_TOWN_IND_NUMBER_LENGTH, town); + SB(ret, CCB_CARGO_TYPE_START, CCB_CARGO_TYPE_LENGTH, ctype); + SB(ret, CCB_COMPANY_START, CCB_COMPANY_LENGTH, company); + return ret; +} + +/** + * Extract the company from the cargo monitor. + * @param num Cargo monitoring number to decode. + * @return The extracted company id. + */ +static inline CompanyID DecodeMonitorCompany(CargoMonitorID num) +{ + return static_cast(GB(num, CCB_COMPANY_START, CCB_COMPANY_LENGTH)); +} + +/** + * Extract the cargo type from the cargo monitor. + * @param num Cargo monitoring number to decode. + * @return The extracted cargo type. + */ +static inline CargoID DecodeMonitorCargoType(CargoMonitorID num) +{ + return GB(num, CCB_CARGO_TYPE_START, CCB_CARGO_TYPE_LENGTH); +} + +/** + * Does the cargo number monitor an industry or a town? + * @param num Cargo monitoring number to decode. + * @return true if monitoring an industry, false if monitoring a town. + */ +static inline bool MonitorMonitorsIndustry(CargoMonitorID num) +{ + return HasBit(num, CCB_IS_INDUSTRY_BIT); +} + +/** + * Extract the industry number from the cargo monitor. + * @param num Cargo monitoring number to decode. + * @return The extracted industry id, or #INVALID_INDUSTRY if the number does not monitor an industry. + */ +static inline IndustryID DecodeMonitorIndustry(CargoMonitorID num) +{ + if (!MonitorMonitorsIndustry(num)) return INVALID_INDUSTRY; + return GB(num, CCB_TOWN_IND_NUMBER_START, CCB_TOWN_IND_NUMBER_LENGTH); +} + +/** + * Extract the town number from the cargo monitor. + * @param num Cargo monitoring number to decode. + * @return The extracted town id, or #INVALID_TOWN if the number does not monitor a town. + */ +static inline TownID DecodeMonitorTown(CargoMonitorID num) +{ + if (MonitorMonitorsIndustry(num)) return INVALID_TOWN; + return GB(num, CCB_TOWN_IND_NUMBER_START, CCB_TOWN_IND_NUMBER_LENGTH); +} + +void ClearCargoPickupMonitoring(); +void ClearCargoDeliveryMonitoring(); +uint32 GetDeliveryAmount(CargoMonitorID monitor, bool keep_monitoring); +uint32 GetPickupAmount(CargoMonitorID monitor, bool keep_monitoring); +void AddCargoDelivery(CargoID cargo_type, CompanyID company, uint32 amount, SourceType src_type, SourceID src, const Station *st); + +#endif /* CARGOMONITOR_H */ -- cgit v1.2.3-54-g00ecf