order_type.h

Go to the documentation of this file.

/*
 * 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/>.
 */
 
#ifndef ORDER_TYPE_H
#define ORDER_TYPE_H
 
#include "core/enum_type.hpp"
#include "depot_type.h"
#include "core/pool_type.hpp"
#include "station_type.h"
 
typedef uint8_t VehicleOrderID;  
using OrderID = PoolID<uint32_t, struct OrderIDTag, 0xFF0000, 0xFFFFFF>;
using OrderListID = PoolID<uint16_t, struct OrderListIDTag, 64000, 0xFFFF>;
 
struct DestinationID {
  using BaseType = uint16_t;
  BaseType value = 0;
 
  explicit DestinationID() = default;
  constexpr DestinationID(size_t index) : value(static_cast<BaseType>(index)) {}
  constexpr DestinationID(DepotID depot) : value(depot.base()) {}
  constexpr DestinationID(StationID station) : value(station.base()) {}
 
  constexpr DepotID ToDepotID() const noexcept { return static_cast<DepotID>(this->value); }
  constexpr StationID ToStationID() const noexcept { return static_cast<StationID>(this->value); }
  constexpr BaseType base() const noexcept { return this->value; }
 
  constexpr bool operator ==(const DestinationID &destination) const { return this->value == destination.value; }
  constexpr bool operator ==(const StationID &station) const { return this->value == station; }
};
 
static const VehicleOrderID INVALID_VEH_ORDER_ID = 0xFF;
static const VehicleOrderID MAX_VEH_ORDER_ID     = INVALID_VEH_ORDER_ID - 1;
 
static const uint IMPLICIT_ORDER_ONLY_CAP = 32;
 
enum OrderType : uint8_t {
  OT_BEGIN         = 0,
  OT_NOTHING       = 0,
  OT_GOTO_STATION  = 1,
  OT_GOTO_DEPOT    = 2,
  OT_LOADING       = 3,
  OT_LEAVESTATION  = 4,
  OT_DUMMY         = 5,
  OT_GOTO_WAYPOINT = 6,
  OT_CONDITIONAL   = 7,
  OT_IMPLICIT      = 8,
  OT_END
};
 
enum OrderUnloadFlags : uint8_t {
  OUF_UNLOAD_IF_POSSIBLE = 0,      
  OUFB_UNLOAD            = 1 << 0, 
  OUFB_TRANSFER          = 1 << 1, 
  OUFB_NO_UNLOAD         = 1 << 2, 
};
 
enum OrderLoadFlags : uint8_t {
  OLF_LOAD_IF_POSSIBLE = 0,      
  OLFB_FULL_LOAD       = 1 << 1, 
  OLF_FULL_LOAD_ANY    = 3,      
  OLFB_NO_LOAD         = 4,      
};
 
enum OrderNonStopFlags : uint8_t {
  ONSF_STOP_EVERYWHERE                  = 0, 
  ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS = 1, 
  ONSF_NO_STOP_AT_DESTINATION_STATION   = 2, 
  ONSF_NO_STOP_AT_ANY_STATION           = 3, 
  ONSF_END
};
 
enum OrderStopLocation : uint8_t {
  OSL_PLATFORM_NEAR_END = 0, 
  OSL_PLATFORM_MIDDLE   = 1, 
  OSL_PLATFORM_FAR_END  = 2, 
  OSL_END
};
 
enum OrderDepotTypeFlags : uint8_t {
  ODTF_MANUAL          = 0,      
  ODTFB_SERVICE        = 1 << 0, 
  ODTFB_PART_OF_ORDERS = 1 << 1, 
};
 
enum OrderDepotActionFlags : uint8_t {
  ODATF_SERVICE_ONLY   = 0,      
  ODATFB_HALT          = 1 << 0, 
  ODATFB_NEAREST_DEPOT = 1 << 1, 
  ODATFB_UNBUNCH       = 1 << 2, 
};
DECLARE_ENUM_AS_BIT_SET(OrderDepotActionFlags)
 
 
enum OrderConditionVariable : uint8_t {
  OCV_LOAD_PERCENTAGE,    
  OCV_RELIABILITY,        
  OCV_MAX_SPEED,          
  OCV_AGE,                
  OCV_REQUIRES_SERVICE,   
  OCV_UNCONDITIONALLY,    
  OCV_REMAINING_LIFETIME, 
  OCV_MAX_RELIABILITY,    
  OCV_END
};
 
enum OrderConditionComparator : uint8_t {
  OCC_EQUALS,      
  OCC_NOT_EQUALS,  
  OCC_LESS_THAN,   
  OCC_LESS_EQUALS, 
  OCC_MORE_THAN,   
  OCC_MORE_EQUALS, 
  OCC_IS_TRUE,     
  OCC_IS_FALSE,    
  OCC_END
};
 
 
enum ModifyOrderFlags : uint8_t {
  MOF_NON_STOP,        
  MOF_STOP_LOCATION,   
  MOF_UNLOAD,          
  MOF_LOAD,            
  MOF_DEPOT_ACTION,    
  MOF_COND_VARIABLE,   
  MOF_COND_COMPARATOR, 
  MOF_COND_VALUE,      
  MOF_COND_DESTINATION,
  MOF_END
};
 
enum OrderDepotAction : uint8_t {
  DA_ALWAYS_GO, 
  DA_SERVICE,   
  DA_STOP,      
  DA_UNBUNCH,   
  DA_END
};
 
enum ModifyTimetableFlags : uint8_t {
  MTF_WAIT_TIME,    
  MTF_TRAVEL_TIME,  
  MTF_TRAVEL_SPEED, 
  MTF_END
};
 
enum CloneOptions : uint8_t {
  CO_SHARE   = 0,
  CO_COPY    = 1,
  CO_UNSHARE = 2
};
 
struct Order;
struct OrderList;
 
#endif /* ORDER_TYPE_H */