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 keeps track of the costs, so you can request how much a block of

    12

 *  commands did cost in total. Works in both Execute as in Test mode.

    13

 * Example:

    14

 *   {

    15

 *     local costs = AIAccounting();

    16

 *     BuildRoad(from_here, to_here);

    17

 *     BuildRoad(from_there, to_there);

    18

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

    19

 *   }

    20

 */

    21

class AIAccounting : public AIObject {

    22

public:

    23

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

    24

    25

	/**

    26

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

    27

	 *   from zero.

    28

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

    29

	 *   current when the instance was created!

    30

	 */

    31

	AIAccounting();

    32

    33

	/**

    34

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

    35

	 *   in when the instance was created.

    36

	 */

    37

	~AIAccounting();

    38

    39

	/**

    40

	 * Get the current value of the costs.

    41

	 * @return The current costs.

    42

	 */

    43

	int32 GetCosts();

    44

    45

	/**

    46

	 * Reset the costs to zero.

    47

	 */

    48

	void ResetCosts();

    49

    50

private:

    51

	int32 last_costs;

    52

};

    53

    54

#endif /* AI_ACCOUNTING_HPP */