Drizzled Public API Documentation

epoch.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 MySQL
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; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #pragma once
22 
23 #include <drizzled/field/str.h>
24 
25 namespace drizzled {
26 namespace field {
27 
28 class Epoch :public Field_str {
29 public:
30 
31  typedef Epoch* pointer;
32 
33  Epoch(unsigned char *ptr_arg,
34  unsigned char *null_ptr_arg,
35  unsigned char null_bit_arg,
36  enum utype unireg_check_arg,
37  const char *field_name_arg,
38  drizzled::TableShare *share);
39 
40  Epoch(bool maybe_null_arg,
41  const char *field_name_arg);
42 
43  enum_field_types type() const { return DRIZZLE_TYPE_TIMESTAMP;}
44  enum ha_base_keytype key_type() const { return HA_KEYTYPE_ULONGLONG; }
45  enum Item_result cmp_type () const { return INT_RESULT; }
46 
47  int store(const char *to,uint32_t length,
48  const charset_info_st * const charset);
49  int store(double nr);
50  int store(int64_t nr, bool unsigned_val);
51  int store_decimal(const type::Decimal *value);
52 
53  int reset(void) { ptr[0]=ptr[1]=ptr[2]=ptr[3]=ptr[4]=ptr[5]=ptr[6]=ptr[7]=0; return 0; }
54  double val_real(void) const;
55  int64_t val_int(void) const;
56  String *val_str(String*,String *) const;
57  int cmp(const unsigned char *,const unsigned char *);
58  void sort_string(unsigned char *buff,uint32_t length);
59  uint32_t pack_length() const { return 8; }
60  virtual bool can_be_compared_as_int64_t() const { return true; }
61  bool zero_pack() const { return 0; }
62  virtual void set_time();
63  virtual void set_default();
64 
65  /* Get TIMESTAMP field value as seconds since begging of Unix Epoch */
66  virtual long get_timestamp(bool *null_value) const;
67 
68  virtual bool is_timestamp() const
69  {
70  return true;
71  }
72 
73 private:
74  bool get_date(type::Time &ltime,uint32_t fuzzydate) const;
75  bool get_time(type::Time &ltime) const;
76 
77 public:
78  virtual timestamp_auto_set_type get_auto_set_type() const;
79  static size_t max_string_length();
80 };
81 
82 } /* namespace field */
83 } /* namespace drizzled */
84 
85