src/ai/api/ai_date.hpp
branchnoai
changeset 9825 cc77111ebd85
child 9829 80fbe02a4184
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/ai/api/ai_date.hpp	Thu Mar 27 05:15:06 2008 +0000
@@ -0,0 +1,67 @@
+/* $Id$ */
+
+/** @file ai_date.hpp declaration of class for AIDate class */
+
+#ifndef AI_DATE_HPP
+#define AI_DATE_HPP
+
+#include "ai_object.hpp"
+
+/**
+ * Class that handles all date related (calculation) functions.
+ *
+ * @note Months and days of month are 1-based; the first month of the
+ *       year is 1 and the first day of the month is also 1.
+ * @note Years are zero based; they start with the year 0.
+ * @note Dates can be used to determine the number of days between
+ *       two different moments in time because they count the number
+ *       of days since the year 0.
+ */
+class AIDate : public AIObject {
+public:
+	/**
+	 * The name of the class, needed by several sub-processes.
+	 */
+	static const char *GetClassName() { return "AIDate"; }
+
+	/**
+	 * Get the current date.
+	 * This is the number of days since epoch under the assumption that
+	 * there is a leap year every 4 years, except when dividable by
+	 * 100 but not by 400.
+	 * @return a date.
+	 */
+	static int32 GetCurrentDate();
+
+	/**
+	 * Get the year of the given date.
+	 * @param date the date to get the year of.
+	 * @return the year.
+	 */
+	static int32 GetYear(int32 date);
+
+	/**
+	 * Get the month of the given date.
+	 * @param date the date to get the month of.
+	 * @return the month.
+	 */
+	static int32 GetMonth(int32 date);
+
+	/**
+	 * Get the day (of the month) of the given date.
+	 * @param date the date to get the day of.
+	 * @return the day.
+	 */
+	static int32 GetDayOfMonth(int32 date);
+
+	/**
+	 * Get the date given a year, month and day of month.
+	 * @param year the year of the to-be determined date.
+	 * @param month the month of the to-be determined date.
+	 * @param day_of_month the day of month of the to-be determined date.
+	 * @return the date.
+	 */
+	static int32 GetDate(int32 year, int32 month, int32 day_of_month);
+};
+
+#endif /* AI_DATE_HPP */