1

/* $Id$ */

     2

     3

/** @file ai_engine.hpp Everything to query and build engines */

     4

     5

#ifndef AI_ENGINE_HPP

     6

#define AI_ENGINE_HPP

     7

     8

#include "ai_object.hpp"

     9

#include "ai_vehicle.hpp"

    10

    11

/**

    12

 * Class that handles all engine related functions.

    13

 */

    14

class AIEngine : public AIObject {

    15

public:

    16

	/**

    17

	 * The name of the class, needed by several sub-processes.

    18

	 */

    19

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

    20

    21

	/**

    22

	 * Checks whether the given engine type is valid and buildable by you.

    23

	 * @param engine_id the engine to check.

    24

	 * @return true if and only if the engine type is valid.

    25

	 */

    26

	static bool IsValidEngine(EngineID engine_id);

    27

    28

	/**

    29

	 * Get the name of an engine.

    30

	 * @param engine_id the engine to get the name of.

    31

	 * @pre IsValidEngine(engine_id).

    32

	 * @return the name the engine has.

    33

	 */

    34

	static char *GetName(EngineID engine_id);

    35

    36

	/**

    37

	 * Get the cargo-type of an engine. In case it can transport 2 cargos, it

    38

	 *  returns the first.

    39

	 * @param engine_id the engine to get the cargo-type of.

    40

	 * @pre IsValidEngine(engine_id).

    41

	 * @return the cargo-type of the engine.

    42

	 */

    43

	static CargoID GetCargoType(EngineID engine_id);

    44

    45

	/**

    46

	 * Get the capacity of an engine. In case it can transport 2 cargos, it

    47

	 *  returns the first.

    48

	 * @param engine_id the engine to get the capacity of.

    49

	 * @pre IsValidEngine(engine_id).

    50

	 * @return the capacity of the engine.

    51

	 */

    52

	static uint32 GetCapacity(EngineID engine_id);

    53

    54

	/**

    55

	 * Get the reliability of an engine. The value is between 0 and 100, where

    56

	 *  100 means 100% reliability (never breaks down) and 0 means 0%

    57

	 *  reliability (you most likely don't want to buy it).

    58

	 * @param engine_id the engine to get the reliability of.

    59

	 * @pre IsValidEngine(engine_id).

    60

	 * @return the reliability the engine has.

    61

	 */

    62

	static uint32 GetReliability(EngineID engine_id);

    63

    64

	/**

    65

	 * Get the max speed of an engine (in km/h).

    66

	 * @param engine_id the engine to get the max speed of.

    67

	 * @pre IsValidEngine(engine_id).

    68

	 * @return the max speed the engine has.

    69

	 */

    70

	static uint32 GetMaxSpeed(EngineID engine_id);

    71

    72

	/**

    73

	 * Get the new cost of an engine.

    74

	 * @param engine_id the engine to get the new cost of.

    75

	 * @pre IsValidEngine(engine_id).

    76

	 * @return the new cost the engine has.

    77

	 */

    78

	static uint32 GetPrice(EngineID engine_id);

    79

    80

	/**

    81

	 * Get the max age of a brand new engine.

    82

	 * @note age is in days; divide by 366 to get per year.

    83

	 * @param engine_id the engine to get the max age of.

    84

	 * @pre IsValidEngine(engine_id).

    85

	 * @returns The max age of a new engine in days.

    86

	 */

    87

	static uint32 GetMaxAge(EngineID engine_id);

    88

    89

	/**

    90

	 * Get the running cost of an engine.

    91

	 * @note cost is per year; divide by 364 to get per day.

    92

	 * @param engine_id the engine to get the running cost of.

    93

	 * @pre IsValidEngine(engine_id).

    94

	 * @return The running cost of a vehicle per year.

    95

	 */

    96

	static Money GetRunningCost(EngineID engine_id);

    97

    98

	/**

    99

	 * Get the type of an engine.

   100

	 * @param engine_id the engine to get the type of.

   101

	 * @pre IsValidEngine(engine_id).

   102

	 * @return the type the engine has.

   103

	 */

   104

	static AIVehicle::VehicleType GetVehicleType(EngineID engine_id);

   105

};

   106

   107

#endif /* AI_ENGINE_HPP */