1

/* $Id$ */

     2

     3

/** @file ai_date.hpp Everything to query and manipulate date related information. */

     4

     5

#ifndef AI_DATE_HPP

     6

#define AI_DATE_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all date related (calculation) functions.

    12

 *

    13

 * @note Months and days of month are 1-based; the first month of the

    14

 *       year is 1 and the first day of the month is also 1.

    15

 * @note Years are zero based; they start with the year 0.

    16

 * @note Dates can be used to determine the number of days between

    17

 *       two different moments in time because they count the number

    18

 *       of days since the year 0.

    19

 */

    20

class AIDate : public AIObject {

    21

public:

    22

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

    23

    24

	/**

    25

	 * Get the current date.

    26

	 * This is the number of days since epoch under the assumption that

    27

	 *  there is a leap year every 4 years, except when dividable by

    28

	 *  100 but not by 400.

    29

	 * @return The current date.

    30

	 */

    31

	static int32 GetCurrentDate();

    32

    33

	/**

    34

	 * Get the year of the given date.

    35

	 * @param date The date to get the year of.

    36

	 * @return The year.

    37

	 */

    38

	static int32 GetYear(int32 date);

    39

    40

	/**

    41

	 * Get the month of the given date.

    42

	 * @param date The date to get the month of.

    43

	 * @return The month.

    44

	 */

    45

	static int32 GetMonth(int32 date);

    46

    47

	/**

    48

	 * Get the day (of the month) of the given date.

    49

	 * @param date The date to get the day of.

    50

	 * @return The day.

    51

	 */

    52

	static int32 GetDayOfMonth(int32 date);

    53

    54

	/**

    55

	 * Get the date given a year, month and day of month.

    56

	 * @param year The year of the to-be determined date.

    57

	 * @param month The month of the to-be determined date.

    58

	 * @param day_of_month The day of month of the to-be determined date.

    59

	 * @return The date.

    60

	 */

    61

	static int32 GetDate(int32 year, int32 month, int32 day_of_month);

    62

};

    63

    64

#endif /* AI_DATE_HPP */