1

/* $Id$ */

     2

     3

/** @file order_type.h Types related to orders. */

     4

     5

#ifndef ORDER_TYPE_H

     6

#define ORDER_TYPE_H

     7

     8

#include "core/enum_type.hpp"

     9

    10

typedef byte VehicleOrderID;  ///< The index of an order within its current vehicle (not pool related)

    11

typedef uint16 OrderID;

    12

typedef uint16 DestinationID;

    13

    14

enum {

    15

	INVALID_VEH_ORDER_ID = 0xFF,

    16

};

    17

    18

static const OrderID INVALID_ORDER = 0xFFFF;

    19

    20

/* Order types */

    21

enum OrderType {

    22

	OT_BEGIN         = 0,

    23

	OT_NOTHING       = 0,

    24

	OT_GOTO_STATION  = 1,

    25

	OT_GOTO_DEPOT    = 2,

    26

	OT_LOADING       = 3,

    27

	OT_LEAVESTATION  = 4,

    28

	OT_DUMMY         = 5,

    29

	OT_GOTO_WAYPOINT = 6,

    30

	OT_CONDITIONAL   = 7,

    31

	OT_END

    32

};

    33

    34

/* It needs to be 8bits, because we save and load it as such */

    35

/** Define basic enum properties */

    36

template <> struct EnumPropsT<OrderType> : MakeEnumPropsT<OrderType, byte, OT_BEGIN, OT_END, OT_END> {};

    37

typedef TinyEnumT<OrderType> OrderTypeByte;

    38

    39

    40

/**

    41

 * Flags related to the unloading order.

    42

 */

    43

enum OrderUnloadFlags {

    44

	OUF_UNLOAD_IF_POSSIBLE = 0,      ///< Unload all cargo that the station accepts.

    45

	OUFB_UNLOAD            = 1 << 0, ///< Force unloading all cargo onto the platform, possibly not getting paid.

    46

	OUFB_TRANSFER          = 1 << 1, ///< Transfer all cargo onto the platform.

    47

	OUFB_NO_UNLOAD         = 1 << 2, ///< Totally no unloading will be done.

    48

};

    49

    50

/**

    51

 * Flags related to the loading order.

    52

 */

    53

enum OrderLoadFlags {

    54

	OLF_LOAD_IF_POSSIBLE = 0,      ///< Load as long as there is cargo that fits in the train.

    55

	OLFB_FULL_LOAD       = 1 << 1, ///< Full load the complete the consist.

    56

	OLF_FULL_LOAD_ANY    = 3,      ///< Full load the a single cargo of the consist.

    57

	OLFB_NO_LOAD         = 4,      ///< Do not load anything.

    58

};

    59

    60

/**

    61

 * Non-stop order flags.

    62

 */

    63

enum OrderNonStopFlags {

    64

	ONSF_STOP_EVERYWHERE                  = 0, ///< The vehicle will stop at any station it passes and the destination.

    65

	ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS = 1, ///< The vehicle will not stop at any stations it passes except the destination.

    66

	ONSF_NO_STOP_AT_DESTINATION_STATION   = 2, ///< The vehicle will stop at any station it passes except the destination.

    67

	ONSF_NO_STOP_AT_ANY_STATION           = 3, ///< The vehicle will not stop at any stations it passes including the destination.

    68

	ONSF_END

    69

};

    70

    71

/**

    72

 * Reasons that could cause us to go to the depot.

    73

 */

    74

enum OrderDepotTypeFlags {

    75

	ODTF_MANUAL          = 0,      ///< Manually initiated order.

    76

	ODTFB_SERVICE        = 1 << 0, ///< This depot order is because of the servicing limit.

    77

	ODTFB_PART_OF_ORDERS = 1 << 1, ///< This depot order is because of a regular order.

    78

};

    79

    80

/**

    81

 * Actions that can be performed when the vehicle enters the depot.

    82

 */

    83

enum OrderDepotActionFlags {

    84

	ODATF_SERVICE_ONLY   = 0,      ///< Only service the vehicle.

    85

	ODATFB_HALT          = 1 << 0, ///< Service the vehicle and then halt it.

    86

	ODATFB_NEAREST_DEPOT = 1 << 1, ///< Send the vehicle to the nearest depot.

    87

};

    88

    89

/**

    90

 * Variables (of a vehicle) to 'cause' skipping on.

    91

 */

    92

enum OrderConditionVariable {

    93

	OCV_LOAD_PERCENTAGE,  ///< Skip based on the amount of load

    94

	OCV_RELIABILITY,      ///< Skip based on the reliability

    95

	OCV_MAX_SPEED,        ///< Skip based on the maximum speed

    96

	OCV_AGE,              ///< Skip based on the age

    97

	OCV_REQUIRES_SERVICE, ///< Skip when the vehicle requires service

    98

	OCV_UNCONDITIONALLY,  ///< Always skip

    99

	OCV_END

   100

};

   101

   102

/**

   103

 * Comparator for the skip reasoning.

   104

 */

   105

enum OrderConditionComparator {

   106

	OCC_EQUALS,      ///< Skip if both values are equal

   107

	OCC_NOT_EQUALS,  ///< Skip if both values are not equal

   108

	OCC_LESS_THAN,   ///< Skip if the value is less than the limit

   109

	OCC_LESS_EQUALS, ///< Skip if the value is less or equal to the limit

   110

	OCC_MORE_THAN,   ///< Skip if the value is more than the limit

   111

	OCC_MORE_EQUALS, ///< Skip if the value is more or equal to the limit

   112

	OCC_IS_TRUE,     ///< Skip if the variable is true

   113

	OCC_IS_FALSE,    ///< Skip if the variable is false

   114

	OCC_END

   115

};

   116

   117

   118

/**

   119

 * Enumeration for the data to set in CmdModifyOrder.

   120

 */

   121

enum ModifyOrderFlags {

   122

	MOF_NON_STOP,        ///< Passes a OrderNonStopFlags.

   123

	MOF_UNLOAD,          ///< Passes an OrderUnloadType.

   124

	MOF_LOAD,            ///< Passes an OrderLoadType

   125

	MOF_DEPOT_ACTION,    ///< Selects the OrderDepotAction

   126

	MOF_COND_VARIABLE,   ///< A conditional variable changes.

   127

	MOF_COND_COMPARATOR, ///< A comparator changes.

   128

	MOF_COND_VALUE,      ///< The value to set the condition to.

   129

	MOF_COND_DESTINATION,///< Change the destination of a conditional order.

   130

	MOF_END

   131

};

   132

   133

/**

   134

 * Depot action to switch to when doing a MOF_DEPOT_ACTION.

   135

 */

   136

enum OrderDepotAction {

   137

	DA_ALWAYS_GO, ///< Always go to the depot

   138

	DA_SERVICE,   ///< Service only if needed

   139

	DA_STOP,      ///< Go to the depot and stop there

   140

	DA_END

   141

};

   142

   143

   144

/* Possible clone options */

   145

enum {

   146

	CO_SHARE   = 0,

   147

	CO_COPY    = 1,

   148

	CO_UNSHARE = 2

   149

};

   150

   151

struct Order;

   152

   153

#endif /* ORDER_TYPE_H */