Drizzled Public API Documentation

time.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 Time :public Field_str {
29 public:
30  Time(unsigned char *ptr_arg,
31  uint32_t len_arg,
32  unsigned char *null_ptr_arg,
33  unsigned char null_bit_arg,
34  const char *field_name_arg);
35 
36  Time(bool maybe_null_arg,
37  const char *field_name_arg);
38 
39  enum_field_types type() const { return DRIZZLE_TYPE_TIMESTAMP;}
40  enum ha_base_keytype key_type() const { return HA_KEYTYPE_LONG_INT; }
41  enum Item_result cmp_type () const { return INT_RESULT; }
42  int store(const char *to,uint32_t length,
43  const charset_info_st * const charset);
44  int store(double nr);
45  int store(int64_t nr, bool unsigned_val);
46  int reset(void) { ptr[0]= ptr[1]= ptr[2]= ptr[3]= 0; return 0; }
47  double val_real(void) const;
48  int64_t val_int(void) const;
49  String *val_str(String*,String *) const;
50  int cmp(const unsigned char *,const unsigned char *);
51  void sort_string(unsigned char *buff,uint32_t length);
52  uint32_t pack_length() const { return 4; }
53  bool can_be_compared_as_int64_t() const { return true; }
54  bool zero_pack() const { return 0; }
55 
56  /* Get TIME field value as seconds since begging of Unix Epoch */
57  long get_timestamp(bool *null_value) const;
58 private:
59  bool get_date(type::Time &ltime, uint32_t fuzzydate) const;
60  bool get_time(type::Time &ltime) const;
61 
62 public:
63  timestamp_auto_set_type get_auto_set_type() const;
64  static size_t max_string_length();
65  void pack_time(drizzled::Time &arg);
66  void unpack_time(drizzled::Time &arg) const;
67  void unpack_time(int32_t &destination, const unsigned char *source) const;
68 };
69 
70 } /* namespace field */
71 } /* namespace drizzled */
72 
73 
TODO: Rename this file - func.h is stupid.
bool can_be_compared_as_int64_t() const
Definition: time.h:53
uint32_t pack_length() const
Definition: time.h:52
Time(unsigned char *ptr_arg, uint32_t len_arg, unsigned char *null_ptr_arg, unsigned char null_bit_arg, const char *field_name_arg)
Definition: time.cc:43
unsigned char * ptr
Definition: field.h:71