1

/* $Id$ */

     2

     3

/** @file ai_accounting.hpp everything to handle AI accounting things */

     4

     5

#ifndef AI_ACCOUNTING_HPP

     6

#define AI_ACCOUNTING_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all AI accounting related functions.

    12

 * Example:

    13

 *   {

    14

 *     local costs = AIAccounting();

    15

 *     BuildRoad(from_here, to_here);

    16

 *     BuildRoad(from_there, to_there);

    17

 *     print("Costs for route is: " + costs.GetCosts());

    18

 *   }

    19

 */

    20

class AIAccounting : public AIObject {

    21

private:

    22

	int32 last_costs;

    23

public:

    24

	/**

    25

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

    26

	 */

    27

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

    28

    29

	/**

    30

	 * Creating instance of this class starts counting the costs of commands

    31

	 *   from zero.

    32

	 * @note when the instance is destroyed, he restores the costs that was

    33

	 *   current when the instance was created!

    34

	 */

    35

	AIAccounting();

    36

    37

	/**

    38

	 * Destroying this instance reset the costs to the value it was

    39

	 *   in when the instance was created.

    40

	 */

    41

	~AIAccounting();

    42

    43

	/**

    44

	 * Get the current value of the costs.

    45

	 */

    46

	int32 GetCosts();

    47

    48

	/**

    49

	 * Reset the costs to zero.

    50

	 */

    51

	void ResetCosts();

    52

};

    53

    54

#endif /* AI_ACCOUNTING_HPP */