1

/* $Id$ */

     2

     3

/** @file ai_order.hpp Everything to query and build orders. */

     4

     5

#ifndef AI_ORDER_HPP

     6

#define AI_ORDER_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all order related functions.

    12

 */

    13

class AIOrder : public AIObject {

    14

public:

    15

	static const char *GetClassName() { return "AIOrder"; }

    16

    17

	/**

    18

	 * Flags that can be used to modify the behaviour of orders.

    19

	 */

    20

	enum AIOrderFlags {

    21

		/** Just go to the station/depot, stop unload if possible and load if needed. */

    22

		AIOF_NONE              = 0,

    23

    24

		/** Transfer instead of deliver the goods; only for stations. */

    25

		AIOF_TRANSFER          = 1 << 0,

    26

		/** Always unload the vehicle; only for stations. Cannot be set when AIOF_FULL_LOAD is set. */

    27

		AIOF_UNLOAD            = 1 << 1,

    28

		/** Wait till the the vehicle is fully loaded; only for stations. Cannot be set when AIOF_UNLOAD is set. */

    29

		AIOF_FULL_LOAD         = 1 << 2,

    30

    31

		/** Service the vehicle when needed, otherwise skip this order; only for depots. */

    32

		AIOF_SERVICE_IF_NEEDED = 1 << 2,

    33

    34

		/** Do not stop at the stations that are passed when going to the destination. */

    35

		AIOF_NON_STOP          = 1 << 3,

    36

    37

		/** For marking invalid order flags */

    38

		AIOF_INVALID           = 0xFFFF,

    39

	};

    40

    41

	/**

    42

	 * Checks whether the given order id is valid for the given vehicle.

    45

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

    47

	 */

    48

	static bool IsValidVehicleOrder(VehicleID vehicle_id, uint32 order_id);

    49

    50

	/**

    51

	 * Checks whether the given order flags are valid for the given destination.

    55

	 */

    56

	static bool AreOrderFlagsValid(TileIndex destination, AIOrderFlags order_flags);

    57

    58

	/**

    59

	 * Returns the number of orders for the given vehicle.

    61

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

    63

	 *   value when the vehicle does not exist.

    64

	 */

    65

	static int32 GetNumberOfOrders(VehicleID vehicle_id);

    66

    67

	/**

    68

	 * Gets the destination of the given order for the given vehicle.

    71

	 * @pre IsValidVehicleOrder(vehicle_id, order_id).

    73

	 */

    74

	static TileIndex GetOrderDestination(VehicleID vehicle_id, uint32 order_id);

    75

    76

	/**

    77

	 * Gets the AIOrderFlags of the given order for the given vehicle.

    80

	 * @pre IsValidVehicleOrder(vehicle_id, order_id).

    82

	 */

    83

	static AIOrderFlags GetOrderFlags(VehicleID vehicle_id, uint32 order_id);

    84

    85

	/**

    86

	 * Appends an order to the end of the vehicle's order list.

    90

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

    91

	 * @pre AreOrderFlagsValid(destination, order_flags).

    93

	 */

    94

	static bool AppendOrder(VehicleID vehicle_id, TileIndex destination, AIOrderFlags order_flags);

    95

    96

	/**

    97

	 * Inserts an order before the given order_id into the vehicle's order list.

   102

	 * @pre IsValidVehicleOrder(vehicle_id, order_id).

   103

	 * @pre AreOrderFlagsValid(destination, order_flags).

   105

	 */

   106

	static bool InsertOrder(VehicleID vehicle_id, uint32 order_id, TileIndex destination, AIOrderFlags order_flags);

   107

   108

	/**

   109

	 * Removes an order from the vehicle's order list.

   112

	 * @pre AIVehicle::IsValidVehicleOrder(vehicle_id, order_id).

   114

	 */

   115

	static bool RemoveOrder(VehicleID vehicle_id, uint32 order_id);

   116

   117

	/**

   118

	 * Changes the order flags of the given order.

   122

	 * @pre IsValidVehicleOrder(vehicle_id, order_id).

   123

	 * @pre AreOrderFlagsValid(GetOrderDestination(vehicle_id, order_id), order_flags).

   125

	 */

   126

	static bool ChangeOrder(VehicleID vehicle_id, uint32 order_id, AIOrderFlags order_flags);

   127

   128

	/**

   129

	 * Move an order inside the orderlist

   133

	 * @pre IsValidVehicleOrder(vehicle_id, order_id_move).

   134

	 * @pre IsValidVehicleOrder(vehicle_id, order_id_target).

   136

	 * @note If the order is moved to a lower place (e.g. from 7 to 2)

   137

	 *  the target order is moved upwards (e.g. 3). If the order is moved

   138

	 *  to a higher place (e.g. from 7 to 9) the target will be moved

   139

	 *  downwards (e.g. 8).

   140

	 */

   141

	static bool MoveOrder(VehicleID vehicle_id, uint32 order_id_move, uint32 order_id_target);

   142

   143

	/**

   148

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

   149

	 * @pre AIVehicle::IsValidVehicle(main_vehicle_id).

   151

	 */

   152

	static bool CopyOrders(VehicleID vehicle_id, VehicleID main_vehicle_id);

   153

   154

	/**

   155

	 * Shares the orders between two vehicles. The orders of the main

   156

	 * vehicle are going to be the orders of the changed vehicle.

   159

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

   160

	 * @pre AIVehicle::IsValidVehicle(main_vehicle_id).

   162

	 */

   163

	static bool ShareOrders(VehicleID vehicle_id, VehicleID main_vehicle_id);

   164

   165

	/**

   166

	 * Removes the given vehicle from a shared orders list.

   168

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

   170

	 */

   171

	static bool UnshareOrders(VehicleID vehicle_id);

   172

};

   173

DECLARE_ENUM_AS_BIT_SET(AIOrder::AIOrderFlags);

   174

   175

#endif /* AI_ORDER_HPP */