← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

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

Renamed more stuff to drizzle.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/function/time/from_days.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_FROM_DAYS_H
21
 
#define DRIZZLED_FUNCTION_TIME_FROM_DAYS_H
22
 
 
23
 
#include "drizzled/function/time/date.h"
24
 
 
25
 
namespace drizzled
26
 
{
27
 
 
28
 
/* forward declarations */
29
 
class Date;
30
 
 
31
 
class Item_func_from_days :public Item_date
32
 
{
33
 
public:
34
 
  Item_func_from_days(Item *a) :Item_date(a) {}
35
 
  const char *func_name() const { return "from_days"; }
36
 
  /**
37
 
   * All functions which inherit from Item_date must implement
38
 
   * their own get_temporal() method, which takes a supplied
39
 
   * Date reference and populates it with a correct
40
 
   * date based on the semantics of the function.
41
 
   *
42
 
   * For FROM_DAYS(), we interpret the function's argument
43
 
   * as a Julian Day Number and populate our supplied Date
44
 
   * reference accordingly.
45
 
   *
46
 
   * Returns whether the function was able to correctly fill
47
 
   * the supplied date temporal with a proper date.
48
 
   *
49
 
   * For a NULL parameter, we return false and set null_value
50
 
   * to true.
51
 
   *
52
 
   * @param Reference to a Date to populate
53
 
   */
54
 
  bool get_temporal(Date &temporal);
55
 
};
56
 
 
57
 
} /* namespace drizzled */
58
 
 
59
 
 
60
 
#endif /* DRIZZLED_FUNCTION_TIME_FROM_DAYS_H */