← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/function/time/last_day.h

  • Committer: Monty Taylor
  • Date: 2009-09-30 07:01:32 UTC
  • mto: This revision was merged to the branch mainline in revision 1184.
  • Revision ID: mordred@inaugust.com-20090930070132-b1ol1xu1rpajdddy
Small namespace cleanup.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/function/time/last_day.h
 
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright (C) 2008 Sun Microsystems
 
5
 *
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; version 2 of the License.
 
9
 *
 
10
 *  This program is distributed in the hope that it will be useful,
 
11
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
 *  GNU General Public License for more details.
 
14
 *
 
15
 *  You should have received a copy of the GNU General Public License
 
16
 *  along with this program; if not, write to the Free Software
 
17
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
18
 */
 
19
 
 
20
#ifndef DRIZZLED_FUNCTION_TIME_LAST_DAY_H
 
21
#define DRIZZLED_FUNCTION_TIME_LAST_DAY_H
 
22
 
 
23
#include "drizzled/function/time/date.h"
 
24
 
 
25
/* forward declarations */
 
26
namespace drizzled {class Date;}
 
27
 
 
28
class Item_func_last_day :public Item_date
 
29
{
 
30
public:
 
31
  Item_func_last_day(Item *a) :Item_date(a) {}
 
32
  const char *func_name() const { return "last_day"; }
 
33
  /**
 
34
   * All functions which inherit from Item_date must implement
 
35
   * their own get_temporal() method, which takes a supplied
 
36
   * drizzled::Date reference and populates it with a correct
 
37
   * date based on the semantics of the function.
 
38
   *
 
39
   * For LAST_DATE(), we interpret the function's argument
 
40
   * as a DateTime string and then figure out the last day of the
 
41
   * month of that date, and populate our reference accordingly.
 
42
   *
 
43
   * Returns whether the function was able to correctly fill
 
44
   * the supplied date temporal with a proper date.
 
45
   *
 
46
   * For a NULL parameter, we return false and set null_value
 
47
   * to true.
 
48
   *
 
49
   * @param Reference to a drizzled::Date to populate
 
50
   */
 
51
  bool get_temporal(drizzled::Date &temporal);
 
52
};
 
53
 
 
54
#endif /* DRIZZLED_FUNCTION_TIME_LAST_DAY_H */