1

/* $Id$ */

     2

     3

/** @file ai_company.hpp Everything to query a company's financials and statistics */

     4

     5

#ifndef AI_COMPANY_HPP

     6

#define AI_COMPANY_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all company related functions.

    12

 */

    13

class AICompany : public AIObject {

    14

public:

    15

	/**

    16

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

    17

	 */

    18

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

    19

    20

	/**

    21

	 * Set the name of your company.

    22

	 * @param name the new name of the company.

    23

	 * @pre name != NULL

    24

	 * @return true if the name was changed.

    25

	 */

    26

	bool SetCompanyName(const char *name);

    27

    28

	/**

    29

	 * Get the name of your company.

    30

	 * @return the name of your company.

    31

	 * @note the returned company name must be free'd (C++ only).

    32

	 */

    33

	char *GetCompanyName();

    34

    35

	/**

    36

	 * Set the name of your president.

    37

	 * @param name the new name of the president.

    38

	 * @pre name != NULL

    39

	 * @return true if the name was changed.

    40

	 */

    41

	bool SetPresidentName(const char *name);

    42

    43

	/**

    44

	 * Get the name of your president.

    45

	 * @return the name of your president.

    46

	 * @note the returned president name must be free'd (C++ only).

    47

	 */

    48

	char *GetPresidentName();

    49

    50

	/**

    51

	 * Gets the current value of your company.

    52

	 * @return the current value of your company.

    53

	 */

    54

	int32 GetCompanyValue();

    55

    56

	/**

    57

	 * Gets the bank balance. In other words, the amount of money you can spent.

    58

	 * @return the bank balance of your company.

    59

	 */

    60

	int32 GetBankBalance();

    61

    62

	/**

    63

	 * Gets the amount your company have loaned.

    64

	 * @return the amount loaned money.

    65

	 * @post the return value is always non-negative.

    66

	 * @post GetLoanInterval() is always a multiplier of the return value.

    67

	 */

    68

	int32 GetLoanAmount();

    69

    70

	/**

    71

	 * Gets the maximum amount your company can loan.

    72

	 * @return the maximum amount your company can loan.

    73

	 * @post the return value is always non-negative.

    74

	 * @post GetLoanInterval() is always a multiplier of the return value.

    75

	 */

    76

	int32 GetMaxLoanAmount();

    77

    78

	/**

    79

	 * Gets the interval/loan step.

    80

	 * @return the loan step.

    81

	 * @post return value is always positive.

    82

	 */

    83

	int32 GetLoanInterval();

    84

    85

	/**

    86

	 * Sets the amount to loan.

    87

	 * @param loan the amount to loan (multiplier of GetLoanInterval()).

    88

	 * @pre loan must be non-negative.

    89

	 * @pre GetLoanInterval must be a multiplier of loan.

    90

	 * @pre loan must be below GetMaxLoan().

    91

	 * @pre loan - GetLoanAmount() + GetBankBalance() must be non-negative.

    92

	 * @return true if the loan could be set to your requested amount.

    93

	 */

    94

	bool SetLoanAmount(int32 loan);

    95

};

    96

    97

#endif /* AI_COMPANY_HPP */