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

class AICompany : public AIObject {

    11

public:

    12

	/**

    13

	 * Set the name of the company

    14

	 * @param name the new name of the company

    15

	 * @pre name != NULL

    16

	 * @return true if the command was send without problem

    17

	 */

    18

	bool SetCompanyName(const char *name);

    19

    20

	/**

    21

	 * Get the name of the company

    22

	 * @return the name of the company

    23

	 * @note the returned company name must be freed

    24

	 */

    25

	char *GetCompanyName();

    26

    27

	/**

    28

	 * Gets the value of the company

    29

	 * @return the value of the company

    30

	 */

    31

	int32 GetCompanyValue();

    32

    33

	/**

    34

	 * Gets the bank balance, i.e. the amount of money that can be spent

    35

	 * @return the bank balance of the company

    36

	 */

    37

	int32 GetBankBalance();

    38

    39

	/**

    40

	 * Gets the amount the company have loaned

    41

	 * @return the amount loaned

    42

	 * @post return >= 0

    43

	 * @post return % this->GetLoanInterval() == 0

    44

	 */

    45

	int32 GetLoanAmount();

    46

    47

	/**

    48

	 * Gets the maximum amount the company can loan

    49

	 * @return the maximum amount the company can loan

    50

	 * @post return >= 0

    51

	 * @post return % this->GetLoanInterval() == 0

    52

	 */

    53

	int32 GetMaxLoanAmount();

    54

    55

	/**

    56

	 * Gets the interval/loan steps

    57

	 * @return the loan steps

    58

	 * @post return >= 0

    59

	 */

    60

	int32 GetLoanInterval();

    61

    62

	/**

    63

	 * Sets the amount to loan

    64

	 * @param loan the amount to load (multitude of GetLoanInterval())

    65

	 * @pre loan >= 0

    66

	 * @pre loan % this->GetLoanInterval() == 0

    67

	 * @pre loan < GetMaxLoan()

    68

	 * @pre loan - GetLoan() + GetBankBalance() > 0

    69

	 * @return true if the command was send without a problem

    70

	 */

    71

	bool SetLoanAmount(int32 loan);

    72

};

    73

    74

#ifdef SQUIRREL_CLASS

    75

void SQAICompanyRegister(SquirrelEngine *engine) {

    76

	DefSQClass <AICompany> SQAICompany("AICompany");

    77

	SQAICompany.PreRegister(engine);

    79

	SQAICompany.DefSQFunction(engine, &AICompany::SetCompanyName,   "SetCompanyName");

    80

	SQAICompany.DefSQFunction(engine, &AICompany::GetCompanyName,   "GetCompanyName");

    81

	SQAICompany.DefSQFunction(engine, &AICompany::GetCompanyValue,  "GetCompanyValue");

    82

	SQAICompany.DefSQFunction(engine, &AICompany::GetBankBalance,   "GetBankBalance");

    83

	SQAICompany.DefSQFunction(engine, &AICompany::GetLoanAmount,    "GetLoanAmount");

    84

	SQAICompany.DefSQFunction(engine, &AICompany::GetMaxLoanAmount, "GetMaxLoanAmount");

    85

	SQAICompany.DefSQFunction(engine, &AICompany::GetLoanInterval,  "GetLoanInterval");

    86

	SQAICompany.DefSQFunction(engine, &AICompany::SetLoanAmount,    "SetLoanAmount");

    87

	SQAICompany.PostRegister(engine);

    88

}

    89

#endif /* SQUIRREL_CLASS */

    90

    91

#endif /* AI_COMPANY_HPP */